> This page is for Analytics API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://documentation.babelstreet.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://documentation.babelstreet.com/_mcp/server.

# Returns event schemas.

GET https://analytics.babelstreet.com/rest/v1/events/info

An event schema defines the event types you are extracting. It includes key phrases, roles, role types, and extractors. You can return the list of all models installed in the system, along with the schemas used to create the model. You can also return the schema for a specific model, where the model is represented by the workspace id (wid).

Reference: https://documentation.babelstreet.com/analytics/text-analytics/event-extractor/returns-event-schemas

## Authentication

- `X-BabelStreetAPI-Key` header (required) — API Key authentication via header
- `X-RosetteAPI-Key` header (required) — API Key authentication via header

## Servers

- `https://analytics.babelstreet.com/rest/v1` (https://analytics.babelstreet.com/rest/v1/, default)
- `https://api.rosette.com/rest/v1` (https://api.rosette.com/rest/v1/)

## Request

### Query parameters

- `workspaceId` (string, optional) — The workspace id for a specific model installed on the server.

## Response

### 200

OK

- `data` (string, optional)
- `identifier` (list of Data, optional)

## Types

### Data

- `version` (string, optional)
- `name` (string, optional)
- `import` (list of string, optional)
- `extractors` (list of Extractors, optional)
- `roleTypes` (list of RoleTypes, optional)
- `eventTypes` (list of EventTypes, optional)

### Extractors

- `name` (string, optional)
- `kind` (enum, optional)
  - Allowed values: `morphological`, `semantic`, `exact`, `entity`
- `useConditions` (list of string, optional)
- `extractorItem` (list of ExtractorItems, optional)

### RoleTypes

- `name` (string, optional)
- `extractors` (list of string, optional)

### EventTypes

- `name` (string, optional)
- `keys` (list of Keys, optional)
- `roles` (list of RoleInfo, optional)

### ExtractorItems

- `surface-form` (string, optional)
- `lemmas` (list of string, optional)
- `types` (list of string, optional)
- `items` (list of string, optional)

### Keys

- `name` (string, optional)
- `roleType` (string, optional)

### RoleInfo

- `name` (string, optional)
- `roleType` (string, optional)
- `required` (boolean, optional)

## Examples

**Response**

```json
{
  "data": "string",
  "identifier": [
    {
      "version": "string",
      "name": "string",
      "import": [
        "string"
      ],
      "extractors": [
        {
          "name": "string",
          "kind": "morphological",
          "useConditions": [
            "string"
          ],
          "extractorItem": [
            {
              "surface-form": "string",
              "lemmas": [
                "string"
              ],
              "types": [
                "string"
              ],
              "items": [
                "string"
              ]
            }
          ]
        }
      ],
      "roleTypes": [
        {
          "name": "string",
          "extractors": [
            "string"
          ]
        }
      ],
      "eventTypes": [
        {
          "name": "string",
          "keys": [
            {
              "name": "string",
              "roleType": "string"
            }
          ],
          "roles": [
            {
              "name": "string",
              "roleType": "string",
              "required": true
            }
          ]
        }
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://analytics.babelstreet.com/rest/v1/events/info"

headers = {"X-BabelStreetAPI-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://analytics.babelstreet.com/rest/v1/events/info';
const options = {method: 'GET', headers: {'X-BabelStreetAPI-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://analytics.babelstreet.com/rest/v1/events/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BabelStreetAPI-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://analytics.babelstreet.com/rest/v1/events/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BabelStreetAPI-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://analytics.babelstreet.com/rest/v1/events/info")
  .header("X-BabelStreetAPI-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://analytics.babelstreet.com/rest/v1/events/info', [
  'headers' => [
    'X-BabelStreetAPI-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://analytics.babelstreet.com/rest/v1/events/info");
var request = new RestRequest(Method.GET);
request.AddHeader("X-BabelStreetAPI-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-BabelStreetAPI-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://analytics.babelstreet.com/rest/v1/events/info")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```