Wit.ai

https://wit.ai/docs
Admin
Wit.ai is a natural language platform that allows developers to easily create and train...
Tokens:124,224
Snippets:669
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Wit.ai Message API Request Example

Source: https://wit.ai/docs/http

This example demonstrates how to make a GET request to the Wit.ai message endpoint to process a user query. It includes the necessary endpoint URL, versioning, query parameters, and authorization header.

```shell
GET https://api.wit.ai/message?v=20240304&q=how%20many%20people%20between%20Tuesday%20and%20Friday
    -H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Get All App Versions (Tags) - Example Response

Source: https://wit.ai/docs/http/20240304

This snippet shows an example response when retrieving all versions (tags) for a Wit.ai application. It's a nested JSON array where each inner array contains tag objects. Each tag object includes its name, creation timestamp, update timestamp, and a description.

```json
[
  [
    {
      "name": "v3",
      "created_at": "2019-09-14T20:29:53-0700",
      "updated_at": "2019-09-14T20:29:53-0700",
      "desc": "third version"
    },
    {
      "name": "v2",
      "created_at": "2019-08-08T11:05:35-0700",
      "updated_at": "2019-08-08T11:09:17-0700",
      "desc": "second version, moved to v3"
    }
  ],
  [
    {
      "name": "v1",
      "created_at": "2019-08-08T11:02:52-0700",
      "updated_at": "2019-09-14T15:45:22-0700",
      "desc": "legacy first version"
    }
  ]
]

```

--------------------------------

### Tokens Format Example

Source: https://wit.ai/docs/http/20240304

Illustrates the format for individual speech tokens, providing the recognized word, start time, and end time in milliseconds.

```json
{
  "token": "pizza",
  "start": 1080,
  "end": 1360
}

```

--------------------------------

### Wit.ai Token Format Example

Source: https://wit.ai/docs/http

An example of the token object within the speech format, detailing individual transcribed words, their start time, and end time in milliseconds.

```json
{
  "token": "pizza",
  "start": 1080,
  "end": 1360
}
```

--------------------------------

### Wit.ai API - Example Response for Client Token Creation

Source: https://wit.ai/docs/http/20200513

This is an example JSON response for the creation or fetching of a client token for a Wit.ai application. It returns the client token string.

```json
{
  "client_token": "A12345AAAAAAAAAAAAAAAAAAAAAAAAAA"
}
```

--------------------------------

### List Apps - JSON Response Example

Source: https://wit.ai/docs/http

Example JSON response for the 'List Apps' endpoint, detailing the structure of an application object including its ID, name, language, privacy settings, and creation timestamp.

```json
[
  {
    "id": "9890809890",
    "name": "My_Second_App",
    "lang": "en",
    "private": false,
    "created_at": "2018-01-01 00:00:01",
    "is_app_for_token": true
  },
  {
    "id": "9890809891",
    "name": "My_Friends_App",
    "lang": "en",
    "private": false,
    "created_at": "2018-01-02 00:00:01"
  }
]
```

--------------------------------

### Get All App Versions (Example Response)

Source: https://wit.ai/docs/http

This JSON structure represents a typical response when fetching multiple versions of an application. It's an array of arrays, where each inner array contains version objects, possibly grouped by creation or update batches.

```json
[ [ { "name": "v3", "created_at": "2019-09-14T20:29:53-0700", "updated_at": "2019-09-14T20:29:53-0700", "desc": "third version" }, { "name": "v2", "created_at": "2019-08-08T11:05:35-0700", "updated_at": "2019-08-08T11:09:17-0700", "desc": "second version, moved to v3" } ], [ { "name": "v1", "created_at": "2019-08-08T11:02:52-0700", "updated_at": "2019-09-14T15:45:22-0700", "desc": "legacy first version" } ] ]
```

--------------------------------

### Example Response for Get Utterances

Source: https://wit.ai/docs/http/20200513

This is an example of the JSON response received when querying the Wit.ai utterances endpoint. It demonstrates the structure of an utterance object, including text, intent, entities, and traits.

```json
[
  {
    "text": "I want to fly SFO",
    "intent": "flight_request",
    "entities": [
      {
        "id": "120890890090903",
        "name": "wit$location",
        "role": "destination",
        "start": 17,
        "end": 20,
        "body": "SFO",
        "entities": []
      }
    ],
    "traits": [
      {
        "id": "198982399822",
        "name": "wit$sentiment",
        "value": "neutral"
      }
    ]
  }
]
```

--------------------------------

### List Apps - cURL Example

Source: https://wit.ai/docs/http/20240304

This cURL command demonstrates how to retrieve a list of apps from the Wit.ai API. It utilizes GET parameters for pagination (offset and limit) and requires an Authorization header for authentication. The response is a JSON array of app objects.

```shell
curl -XGET 'https://api.wit.ai/apps?v=20240304&offset=1&limit=2' \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json"
```

--------------------------------

### Wit.ai Full Composer Response Example

Source: https://wit.ai/docs/http/20240304

A comprehensive JSON example of a 'FULL_COMPOSER' response from the Wit.ai API. It includes speech tokens, the recognized text, and context map details.

```json
{
  "context_map": {
    "color": [
      {
        "body": "green",
        "confidence": 1,
        "end": 13,
        "entities": {},
        "id": "3025574414362129",
        "name": "color",
        "role": "color",
        "start": 8,
        "type": "value",
        "value": "green"
      }
    ]
  },
  "is_final": true,
  "response": {
    "text": "As you can see, I have turned green."
  },
  "speech": {
    "confidence": 0.9956,
    "tokens": [
      {
        "confidence": 0.9952,
        "end": 540,
        "start": 0,
        "token": "Make"
      },
      {
        "confidence": 0.9948,
        "end": 720,
        "start": 540,
        "token": "it"
      },
      {
        "confidence": 0.9969,
        "end": 900,
        "start": 720,
        "token": "green"
      }
    ]
  },
  "text": "Make it green",
  "type": "FULL_COMPOSER"
}
```

--------------------------------

### Wit.ai Speech Token Example

Source: https://wit.ai/docs/http/20240304

An example of a speech token object within the Wit.ai API response. It contains confidence scores, start and end times, and the recognized token.

```json
{
  "confidence": 0.9952,
  "end": 540,
  "start": 0,
  "token": "Make"
}
```

--------------------------------

### Audio Content-Type Examples

Source: https://wit.ai/docs/http

Examples of Content-Type headers for different audio formats supported by the Wit.ai API. This includes standard formats like WAV and MP3, as well as raw audio with specific encoding parameters.

```text
'content-type': 'audio/wav'
'content-type': 'audio/mpeg3'
'content-type': 'audio/ogg'
'content-type': 'audio/ulaw'
'content-type': 'audio/raw;encoding=unsigned-integer;bits=16;rate=8000;endian=big'
```

--------------------------------

### Wit.ai Speech Synthesis Example (JSON Input)

Source: https://wit.ai/docs/http/20200513

Illustrates the JSON structure representing partial and final speech transcriptions from Wit.ai, including token start and end times, and the transcribed text.

```json
{
  "speech": {
    "tokens": [
      {
        "end": 4500,
        "start": 3500,
        "token": "You"
      },
      {
        "end": 4680,
        "start": 4500,
        "token": "take"
      },
      {
        "end": 4920,
        "start": 4680,
        "token": "away"
      },
      {
        "end": 5400,
        "start": 4920,
        "token": "the"
      }
    ]
  },
  "text": "You take away the",
  "type": "PARTIAL_TRANSCRIPTION"
}
```

```json
{
  "is_final": true,
  "speech": {
    "tokens": [
      {
        "end": 4500,
        "start": 3500,
        "token": "You"
      },
      {
        "end": 4680,
        "start": 4500,
        "token": "take"
      },
      {
        "end": 4920,
        "start": 4680,
        "token": "away"
      },
      {
        "end": 5400,
        "start": 4920,
        "token": "the"
      },
      {
        "end": 5580,
        "start": 5400,
        "token": "S"
      }
    ]
  },
  "text": "You take away the S",
  "type": "FINAL_TRANSCRIPTION"
}
```

--------------------------------

### Wit.ai API - Example Response for App Update

Source: https://wit.ai/docs/http/20200513

This is an example JSON response indicating the success of an app update operation on the Wit.ai API.

```json
{
  "success": true
}
```

--------------------------------

### Example Wit.ai API Event Request using cURL

Source: https://wit.ai/docs/http/20240304

Provides a complete cURL command for making a POST request to the Wit.ai event API. This example includes query parameters for version, session ID, and context map, along with Authorization headers and a JSON payload for user input.

```bash
$ curl -XPOST 'https://api.wit.ai/event?v=20240304&session_id=t6v&context_map=%7B%0A%20%20%22shape_color%22%3A%20%22red%22%0A%7D' \
 -H "Authorization: Bearer $TOKEN" \
 -d '{"type": "message", "message": "what color is the shape?"}'
```

--------------------------------

### Get Specific App Info - cURL Example

Source: https://wit.ai/docs/http/20240304

This cURL command shows how to fetch detailed information for a single app using its ID. It employs a GET request to the API endpoint with the app ID and includes necessary authentication and content type headers. The response provides comprehensive details about the specified app.

```shell
curl -XGET 'https://api.wit.ai/apps/2802177596527671?v=20240304' \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json"
```

--------------------------------

### Get Specific App Version Response (JSON)

Source: https://wit.ai/docs/http

This JSON object is an example response for retrieving a specific app version. It includes the version name, creation timestamp, last update timestamp, and a description.

```json
{
  "name": "v1",
  "created_at": "2019-08-08T11:02:52-0700",
  "updated_at": "2019-09-14T15:45:22-0700",
  "desc": "first version"
}
```

--------------------------------

### Example Wit.ai Message API Request (cURL)

Source: https://wit.ai/docs/http/20240304

A cURL command example for making a request to the Wit.ai /message endpoint with a query and authorization token.

```bash
$ curl -XGET 'https://api.wit.ai/message?v=20240304&q=how%20many%20people%20between%20Tuesday%20and%20Friday' \
    -H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Example Wit.ai Utterances Response (JSON)

Source: https://wit.ai/docs/http

Example JSON response from the Wit.ai /utterances endpoint, showcasing a flight request utterance with identified entities and traits.

```json
[
  {
    "text": "I want to fly SFO",
    "intent": "flight_request",
    "entities": [
      {
        "id": "120890890090903",
        "name": "wit$location",
        "role": "destination",
        "start": 17,
        "end": 20,
        "body": "SFO",
        "entities": []
      }
    ],
    "traits": [
      {
        "id": "198982399822",
        "name": "wit$sentiment",
        "value": "neutral"
      }
    ]
  },
]
```

--------------------------------

### Wit.ai - Partial Transcription Example

Source: https://wit.ai/docs/http/20200513

This example demonstrates a partial transcription of the input text 'How many'. It highlights the text and its transcription type, useful for tracking incremental speech recognition. No external dependencies are required for this basic structure.

```JSON
{
  "text": "How many",
  "type": "PARTIAL_TRANSCRIPTION"
}
```

--------------------------------

### Wit.ai Speech API Context Example (cURL)

Source: https://wit.ai/docs/http/20240304

Example of a cURL command to send audio to the Wit.ai speech API, including reference time and timezone in the context.

```shell
$ curl -XPOST 'https://api.wit.ai/speech?v=20240304&context=%7B%22reference_time%22%3A%222013-05-01T19%3A05%3A00%22%2C%22timezone%22%3A%22America%2FLos_Angeles%22%7D' \
 -i -L \
 -H "Authorization: Bearer $TOKEN" \
 -H "Content-Type: audio/wav" \
 --data-binary "@sample.wav"
```

--------------------------------

### Wit.ai Speech API Dynamic Entities Example (JSON)

Source: https://wit.ai/docs/http/20240304

Example JSON payload for the Wit.ai speech API demonstrating how to provide dynamic entities, specifically for a 'color' entity with keywords and synonyms.

```json
{
  "entities": {
    "color": [
      {
        "keyword": "purple",
        "synonyms": ["violet", "magenta"]
      },
      {
        "keyword": "blue",
        "synonyms": ["aqua blue", "marine blue"]
      }
    ]
  }
}
```

--------------------------------

### Wit.ai Intent Format Example

Source: https://wit.ai/docs/http/20240304

An example of the JSON format for an intent returned by the Wit.ai API, including its ID, name, and confidence score.

```json
{
  "id": "564526617811614",
  "name": "get_weather",
  "confidence": 0.9942
}
```

--------------------------------

### Get Specific App Info Response - JSON Example

Source: https://wit.ai/docs/http/20240304

This JSON object details the response for retrieving information about a specific app from the Wit.ai API. It includes the app's unique identifier, name, language, privacy settings, creation and training timestamps, and training status.

```json
{
  "id": "2802177596527671",
  "name": "alarm-clock",
  "lang": "en",
  "private": false,
  "created_at": "2018-07-29T18:15:34-0700",
  "last_training_duration_secs": 0,
  "will_train_at": "2018-07-29T18:17:34-0700",
  "last_trained_at": "2018-07-29T18:18:34-0700",
  "training_status": "done"
}
```

--------------------------------

### Wit.ai Message API Context Example (cURL)

Source: https://wit.ai/docs/http/20240304

Example of a cURL command to query the Wit.ai message API, including timezone, locale, and coordinates in the context.

```shell
$ curl -XGET 'https://api.wit.ai/message?v=20240304&q=chicago&context=%7B%22timezone%22%3A%22America%2FLos_Angeles%22%2C%22locale%22%3A%22en_CA%22%2C%22coords%22%3A%7B%22lat%22%3A37.47104%2C%22long%22%3A-122.14703%7D%7D' \
 -H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Wit.ai Converse API Request Example with cURL and sox

Source: https://wit.ai/docs/http/20240304

This example demonstrates how to send audio data (recorded using `sox`) to the Wit.ai Converse API using `curl`. It includes setting authentication, content type, and other necessary headers for a WAV audio stream.

```bash
$ sox -d -t wav -c 1 -r 16k -b 16 -e signed-integer --endian little - trim 0 2 | \
    curl -XPOST "https://api.wit.ai/converse?v=20240304&session_id=x1d&context_map=%7B%7D" \
      -H "Authorization: Bearer $TOKEN" -T - \
      -H "Content-Type: audio/wav" -H "Transfer-encoding: chunked" -Ss
```

--------------------------------

### Get All Versions for an App (GET API)

Source: https://wit.ai/docs/http

Retrieves an array of all tag groups for a given Wit.ai app. Each tag group represents a specific state of the app. The response includes details like version name, creation, and update timestamps, along with a description.

```shell
curl -XGET 'https://api.wit.ai/apps/226942688552688/tags?v=20240304' \
-H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Add Keywords to Entity Example - cURL

Source: https://wit.ai/docs/http/20240304

Example cURL command to add a new keyword ('Brussels') with synonyms to the 'favorite_city' entity. It specifies the content type and provides the JSON payload.

```bash
$ curl -XPOST 'https://api.wit.ai/entities/favorite_city/keywords?v=20240304' \
 -H "Authorization: Bearer $TOKEN" \
 -H 'Content-Type: application/json' \
 -d '{"keyword": "Brussels",
      "synonyms": ["Brussels", "Capital of Europe"]}'
```

--------------------------------

### Get all apps

Source: https://wit.ai/docs/http

Retrieves a list of all applications that the authenticated user owns or contributes to.

```APIDOC
## Get all your apps

### Description
Returns an array of all the apps that you own and contribute to.

### Method
GET

### Endpoint
https://api.wit.ai/apps

### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Response
#### Success Response (200)
- **array** (array) - A list of app objects.
  - **id** (string) - The unique identifier of the app.
  - **name** (string) - The name of the app.
  - **lang** (string) - The primary language of the app.
  - **teams** (array) - A list of teams associated with the app.
    - **id** (string) - The unique identifier of the team.
    - **name** (string) - The name of the team.
  - **created_at** (string) - The timestamp when the app was created.
  - **public** (boolean) - Indicates if the app is public.
  - **type** (string) - The type of the app (e.g., 'default').
  - **outcomes** (array) - A list of possible outcomes for the app.
    - **id** (string) - The unique identifier of the outcome.
    - **name** (string) - The name of the outcome.
  - **private_}))
  - **private_})** (boolean) - Indicates if the app is private.
  - **settings** (object) - App-specific settings.
    - **nlp_confidence_threshold** (number) - The confidence threshold for NLP suggestions.
    - **verbose_logging** (boolean) - Whether verbose logging is enabled.
    - **min_api_traffic** (integer) - Minimum API traffic threshold.
    - **language_order** (array) - Preferred order of languages.
    - **locale_parsing_enabled** (boolean) - Whether locale parsing is enabled.
    - **date_includes_time** (boolean) - Whether date parsing includes time.
    - **check_for_updates** (boolean) - Whether to check for updates.
    - **client_token** (string) - The client token for the app.
    - **server_access_token** (string) - The server access token for the app.
    - **intent_trimming** (boolean) - Whether intent trimming is enabled.
    - **allow_null_output** (boolean) - Whether null outputs are allowed.
    - **stop_words** (array) - A list of stop words.
    - **disable_auto_wit_better** (boolean) - Whether auto-Wit-better is disabled.
    - **remove_stopwords** (boolean) - Whether stop words are removed.
    - **keep_only_first_intent** (boolean) - Whether to keep only the first intent.
    - **fixed_wit_entities** (boolean) - Whether wit entities are fixed.
    - **wit_entities_only** (boolean) - Whether to only consider wit entities.

#### Response Example
```json
[
  {
    "id": "1234567890",
    "name": "My Awesome App",
    "lang": "en",
    "teams": [
      {
        "id": "0987654321",
        "name": "My Team"
      }
    ],
    "created_at": "2023-01-01T12:00:00.000Z",
    "public": false,
    "type": "default",
    "outcomes": [
      {
        "id": "outcome1",
        "name": "Greeting"
      }
    ],
    "private_": true,
    "settings": {
      "nlp_confidence_threshold": 0.5,
      "verbose_logging": false,
      "min_api_traffic": 100,
      "language_order": ["en", "es"],
      "locale_parsing_enabled": true,
      "date_includes_time": false,
      "check_for_updates": true,
      "client_token": "abc123xyz",
      "server_access_token": "def456uvw",
      "intent_trimming": false,
      "allow_null_output": false,
      "stop_words": [],
      "disable_auto_wit_better": false,
      "remove_stopwords": false,
      "keep_only_first_intent": false,
      "fixed_wit_entities": false,
      "wit_entities_only": false
    }
  }
]
```
```

--------------------------------

### Wit.ai Speech Synthesis Example JSON Request Body (Final Transcription)

Source: https://wit.ai/docs/http/20240304

Example of a JSON object representing a final transcription from Wit.ai's speech recognition. It includes a flag indicating completion and detailed token information.

```JSON
{
  "is_final": true,
  "speech": {
    "confidence": 0.9309,
    "tokens": [
      {
        "end": 4500,
        "start": 3500,
        "token": "You"
      },
      {
        "end": 4680,
        "start": 4500,
        "token": "take"
      },
      {
        "end": 4920,
        "start": 4680,
        "token": "away"
      },
      {
        "end": 5400,
        "start": 4920,
        "token": "the"
      },
      {
        "end": 5580,
        "start": 5400,
        "token": "S"
      }
    ]
  },
  "text": "You take away the S",
  "type": "FINAL_TRANSCRIPTION"
}
```

--------------------------------

### Add Entity Keyword with cURL (POST Request)

Source: https://wit.ai/docs/http/20240304

This example illustrates how to add a keyword to an entity in Wit.ai using an HTTP POST request with cURL. It includes setting the Authorization, Content-Type, and sending a JSON payload with the keyword and its synonyms. This is an example of a write operation requiring a server token.

```shell
$ curl -XPOST 'https://api.wit.ai/entities/favorite_city/keywords?v=20240304' \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"keyword":"Paris","synonyms":["Paris", "City of Light", "Capital of France"]}'
```

--------------------------------

### Create App

Source: https://wit.ai/docs/http

Creates a new application for an existing user with specified configurations.

```APIDOC
## POST /apps

### Description
Creates a new application for an existing user with specified configurations.

### Method
POST

### Endpoint
https://api.wit.ai/apps

### Parameters
#### Request Body
- **name** (string) - Required - Name of the new app.
- **lang** (string) - Required - Language code, in the ISO 639-1 format.
- **private** (bool) - Required - Private if `true`.
- **timezone** (string) - Optional - Default timezone of your app. Defaults to `America/Los_Angeles`.

### Request Example
```bash
curl -XPOST 'https://api.wit.ai/apps?v=20240304' \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "My_New_App", "lang": "en", "private": false, "timezone": "Europe/Brussels"}'
```
```

--------------------------------

### Create App

Source: https://wit.ai/docs/http/20240304

Creates a new application for an existing user with specified configuration.

```APIDOC
## POST /apps

### Description
Creates a new application for an existing user with specified configuration.

### Method
POST

### Endpoint
https://api.wit.ai/apps

### Parameters
#### Request Body
- **name** (string) - Required - Name of the new app.
- **lang** (string) - Required - Language code, in the ISO 639-1 format.
- **private** (boolean) - Required - Private if `true`.
- **timezone** (string) - Optional - Default timezone of your app. Defaults to `America/Los_Angeles`.

### Request Example
```bash
curl -XPOST 'https://api.wit.ai/apps?v=20240304' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My_New_App",
      "lang": "en",
      "private": false,
      "timezone": "Europe/Brussels"}'
```

### Response
*(Note: The response structure for creating an app is not explicitly provided in the input text, but typically it would return the created app object or its ID.)*
#### Success Response (201 Created)
*(Example structure based on common API practices)*
```json
{
  "id": "new-app-id",
  "name": "My_New_App",
  "lang": "en",
  "private": false,
  "timezone": "Europe/Brussels",
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Get Utterances from Wit.ai API

Source: https://wit.ai/docs/http/20200513

This snippet shows how to make a GET request to the Wit.ai API to retrieve utterances. It includes example parameters like version and limit, and requires an Authorization header with a bearer token. The response is a JSON array of utterance objects.

```bash
GET https://api.wit.ai/utterances
```

```bash
$ curl -XGET 'https://api.wit.ai/utterances?v=20240304&limit=10' \
 -H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Wit.ai API: Example JSON Response for Client Action

Source: https://wit.ai/docs/http/20240304

This JSON response from the Wit.ai API indicates that a client action should be run, expecting further input from the user. It includes context and action details.

```json
{
  "context_map": {
    "quick_reply_payload": {
      "text": "yes",
      "option": 1
    }
  },
  "action": "run_confirmation",
  "expects_input": true,
  "is_final": true,
  "type": "FULL_COMPOSER"
}
```

--------------------------------

### GET /message

Source: https://wit.ai/docs/http/20240304

Interprets a given text query and extracts intents and entities, optionally using dynamic entities to guide the interpretation.

```APIDOC
## GET /message

### Description
Interprets a given text query and extracts intents and entities, optionally using dynamic entities to guide the interpretation.

### Method
GET

### Endpoint
https://api.wit.ai/message

### Parameters
#### Query Parameters
- **v** (string) - Required - The API version date (e.g., 20240304).
- **q** (string) - Required - The text query to interpret.
- **entities** (JSON object) - Optional - Dynamic entities to be used for interpretation.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication (e.g., Bearer $TOKEN).

### Request Example
```bash
curl -XGET 'https://api.wit.ai/message?v=20240304&q=I+like+aqua+marine&entities=%7B%0A%20%20%20%20%22color%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22keyword%22%3A%20%22purple%22%2C%0A%20%20%20%20%20%20%20%20%22synonyms%22%3A%20%5B%22violet%22%2C%20%22magenta%22%5D%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22keyword%22%3A%20%22blue%22%2C%0A%20%20%20%20%20%20%20%20%22synonyms%22%3A%20%5B%22aqua%20blue%22%2C%20%22marine%20blue%22%5D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%7D' \
    -H "Authorization: Bearer $TOKEN"
```

### Response
#### Success Response (200)
- **text** (string) - The input query text.
- **intents** (array) - List of potential intents identified.
- **entities** (object) - Extracted entities from the query.

#### Response Example
```json
{
  "text": "I like aqua marine",
  "intents": [
    {
      "intent": "express_liking",
      "confidence": "0.88"
    }
  ],
  "entities": {
    "color": [
      {
        "value": "aqua blue",
        "type": "color"
      },
      {
        "value": "marine blue",
        "type": "color"
      }
    ]
  }
}
```
```

--------------------------------

### Wit.ai Dictation API POST Request Example

Source: https://wit.ai/docs/http/20200513

A cURL command demonstrating how to send an audio file to the Wit.ai dictation endpoint. It includes setting the Authorization token, Content-Type header, and sending the audio data as binary.

```bash
$ curl -XPOST 'https://api.wit.ai/dictation?v=20240304' \
    -i -L \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: audio/wav" \
    --data-binary "@audio.wav"

```

--------------------------------

### Wit.ai - Partial Understanding Example

Source: https://wit.ai/docs/http/20200513

This snippet shows a partial understanding of the input text 'How'. It includes confidence scores for intents and speech tokens, indicating the initial processing stages. Dependencies include the Wit.ai SDK.

```JSON
{
  "intents": [
    {
      "confidence": 0.9288,
      "id": "1048434629118182",
      "name": "inquiry"
    }
  ],
  "speech": {
    "confidence": 0.6927,
    "tokens": [
      {
        "end": 360,
        "start": 0,
        "token": "How"
      }
    ]
  },
  "text": "How",
  "traits": {},
  "type": "PARTIAL_UNDERSTANDING"
}
```

--------------------------------

### Wit.ai Message API Context Example (GET /message)

Source: https://wit.ai/docs/http

This snippet illustrates the context object for the GET /message endpoint, including timezone, locale, and user coordinates. Providing these details helps Wit.ai resolve entities more accurately, especially location-based and language-specific ones. Coordinates should be in {'lat': float, 'long': float} format.

```json
{
  "timezone": "America/Los_Angeles",
  "locale": "en_US",
  "coords": {
    "lat": 37.47104,
    "long": -122.14703
  }
}
```

--------------------------------

### Make a Wit.ai API Request with cURL

Source: https://wit.ai/docs/http/20240304

This example demonstrates how to make a basic API request to Wit.ai using the cURL command-line tool. It includes setting the necessary Authorization header with an access token. Ensure you replace `$TOKEN` with your actual instance token.

```shell
$ curl 'https://api.wit.ai/message?v=20240304&q=hello' \
-H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Retrieve Entity Information using Wit.ai API

Source: https://wit.ai/docs/http

Shows how to retrieve all available information for a specific entity using the Wit.ai API. This involves a GET request to the /entities/:entity endpoint. The example includes a cURL command with necessary headers like Authorization.

```bash
$ curl -XGET 'https://api.wit.ai/entities/first_name?v=20240304' \
 -H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Create New App Version Response (JSON)

Source: https://wit.ai/docs/http

This JSON object is an example response after successfully creating a new app version. It confirms the operation by returning the name of the tag that was created.

```json
{
  "tag": "v_1"
}
```

--------------------------------

### POST /import

Source: https://wit.ai/docs/http

Imports your application data from a ZIP backup file to create a new Wit.ai application.

```APIDOC
## POST /import

### Description
Creates a new app with all the app data from the exported app.

### Method
POST

### Endpoint
https://api.wit.ai/import

### Query Parameters
- **v** (string) - Required - API version date (e.g., 20240304)
- **name** (string) - Required - Name of the new app.
- **private** (string) - Required - Set to `true` if the app should be private.

### Request Body
- **file** (file) - Required - The ZIP file containing the app data to import.

### Request Example
```json
{
  "request_type": "curl",
  "request_details": "-XPOST 'https://api.wit.ai/import?v=20240304&name=newapp&private=false' \
-H \"Authorization: Bearer $TOKEN\" \
-H \"Content-Type: application/zip\" \
--data-binary \"@$HOME/exported.zip\""
}
```

### Response
#### Success Response (200)
- **name** (string) - The name of the newly created app.
- **access_token** (string) - The access token for the new app.
- **app_id** (string) - The ID of the new app.

#### Response Example
```json
{
  "name": "newapp",
  "access_token": "NEW_ACCESS_TOKEN",
  "app_id": "NEW_APP_ID"
}
```
```

--------------------------------

### Get Specific App Version (Tag) - Example Response

Source: https://wit.ai/docs/http/20240304

This snippet shows the JSON response when requesting details for a specific version (tag) of a Wit.ai app. It contains the version's name, creation date, last update date, and a short description.

```json
{
  "name": "v1",
  "created_at": "2019-08-08T11:02:52-0700",
  "updated_at": "2019-09-14T15:45:22-0700",
  "desc": "first version"
}

```

--------------------------------

### Create App - POST Request

Source: https://wit.ai/docs/http

Creates a new application with specified name, language, and privacy settings. Optionally includes timezone. Requires 'Authorization' and 'Content-Type' headers, and a JSON request body.

```shell
POST https://api.wit.ai/apps

$ curl -XPOST 'https://api.wit.ai/apps?v=20240304' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My_New_App",
        "lang": "en",
        "private": false,
        "timezone": "Europe/Brussels"}'
```

--------------------------------

### Get Specific App Version (Tag) - cURL Request

Source: https://wit.ai/docs/http/20240304

This is an example cURL command to retrieve information for a specific version (tag) of a Wit.ai app. It includes the application ID, the tag name, and an authorization token. The `v` parameter specifies the API version.

```bash
$ curl -XGET 'https://api.wit.ai/apps/226942688552688/tags/v1?v=20240304' \
-H "Authorization: Bearer $TOKEN"
```

--------------------------------

### POST /apps

Source: https://wit.ai/docs/http/20200513

Creates a new application for the authenticated user.

```APIDOC
## Create a new app

### Description
Creates a new app for an existing user.

### Method
POST

### Endpoint
https://api.wit.ai/apps

### Parameters
#### Request Body
- **name** (string) - Required - Name of the new app.
- **lang** (string) - Required - Language code, in the ISO 639-1 format.
- **private** (boolean) - Required - True if the app should be private.
- **timezone** (string) - Optional - Default timezone of your app. Defaults to `America/Los_Angeles`.

### Request Example
```
POST https://api.wit.ai/apps?v=20240304
```
```bash
curl -XPOST 'https://api.wit.ai/apps?v=20240304' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My_New_App",
    "lang": "en",
    "private": false,
    "timezone": "Europe/Brussels"
  }'
```

### Response
#### Success Response (200)
- **id** (string) - A unique identifier of the newly created app.
- **name** (string) - The name of the app.
- **lang** (string) - Language code, in the ISO 639-1 format.
- **private** (boolean) - True if the app is private.
- **created_at** (string) - Date and time of the app creation, in the ISO 8601 format.
- **timezone** (string) - The timezone of the app.
```

--------------------------------

### Wit.ai Get Intents Response Example

Source: https://wit.ai/docs/http/20240304

This JSON array represents the response from the Wit.ai '/intents' endpoint, listing available intents. Each intent object includes a unique ID and its corresponding name, providing a structured overview of the app's defined intents.

```json
[
  {
    "id": "2690212494559269",
    "name": "buy_car"
  },
  {
    "id": "233273197778131",
    "name": "make_call"
  },
  {
    "id": "708611983192814",
    "name": "wit$get_weather"
  },
  {
    "id": "854486315384573",
    "name": "wit$play_music"
  }
]
```

--------------------------------

### Create New App Version (Tag) - Example Response

Source: https://wit.ai/docs/http/20240304

This JSON response confirms the successful creation of a new version (tag) for a Wit.ai application. It returns an object containing the name of the newly created tag.

```json
{
  "tag": "v_1"
}

```

--------------------------------

### Wit.ai Message API GET Request with Dynamic Entities (cURL)

Source: https://wit.ai/docs/http

This example shows how to query the Wit.ai message API with a specific text input and dynamic entities. The 'color' entity is defined with keywords and synonyms to influence the message parsing. Authentication is handled via a bearer token.

```shell
$ curl -XGET 'https://api.wit.ai/message?v=20240304&q=I+like+aqua+marine&entities=%7B%0A%20%20%20%20%22color%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22keyword%22%3A%20%22purple%22%2C%0A%20%20%20%20%20%20%20%20%22synonyms%22%3A%20%5B%22violet%22%2C%20%22magenta%22%5D%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22keyword%22%3A%20%22blue%22%2C%0A%20%20%20%20%20%20%20%20%22synonyms%22%3A%20%5B%22aqua%20blue%22%2C%20%22marine%20blue%22%5D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%7D' \
    -H "Authorization: Bearer $TOKEN"
```

--------------------------------

### Wit.ai Initial Analysis Example (JSON)

Source: https://wit.ai/docs/http/20240304

This snippet illustrates an initial analysis by Wit.ai, showing partial understanding of the input text. It includes recognized entities, intents, and speech tokens, but the overall understanding type is 'PARTIAL_UNDERSTANDING'.

```json
{
  "entities": {
    "wit$datetime": [
      {
        "role": "datetime",
        "type": "value",
        "value": "2022-06-14T00:00:00.000-07:00",
        "values": [
          {
            "grain": "day",
            "type": "value",
            "value": "2022-06-14T00:00:00.000-07:00"
          },
          {
            "grain": "day",
            "type": "value",
            "value": "2022-06-21T00:00:00.000-07:00"
          },
          {
            "grain": "day",
            "type": "value",
            "value": "2022-06-28T00:00:00.000-07:00"
          }
        ]
      }
    ]
  },
  "intents": [
    {
      "confidence": 0.9996,
      "id": "1048434629118182",
      "name": "inquiry"
    }
  ],
  "speech": {
    "confidence": 0.7485,
    "tokens": [
      {
        "end": 360,
        "start": 0,
        "token": "How"
      },
      {
        "end": 600,
        "start": 360,
        "token": "many"
      },
      {
        "end": 840,
        "start": 600,
        "token": "people"
      },
      {
        "end": 1320,
        "start": 840,
        "token": "between"
      },
      {
        "end": 1620,
        "start": 1320,
        "token": "Tuesday"
      }
    ]
  },
  "text": "How many people between Tuesday",
  "traits": {},
  "type": "PARTIAL_UNDERSTANDING"
}
```

--------------------------------

### Add Utterances with Composite Entities to Wit.ai App (cURL)

Source: https://wit.ai/docs/http

This example shows how to add utterances with complex entities, such as composite entities (e.g., car model and color), to a Wit.ai application using cURL. It includes specifying entity properties like 'start', 'end', and 'body', as well as traits like sentiment. The API handles this data asynchronously.

```shell
$ curl -XPOST 'https://api.wit.ai/utterances?v=20240304' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{ "text": "I want a blue toyota", "intent": "buy_car", "entities": [ { "entity": "car:car", "start": 9, "end": 20, "body": "blue toyota", "entities": [ { "entity":"color:color", "start": 0, "end": 4, "body": "blue", "entities": [] }, { "entity":"model", "start": 5, "end": 11, "body": "toyota", "entities": [] } ] } ], "traits": [ { "trait": "wit$sentiment", "value": "neutral" } ] }]'
```

```json
{
  "sent": true,
  "n": 1
}
```

--------------------------------

### Wit.ai Get Intents GET Request

Source: https://wit.ai/docs/http/20240304

This cURL command demonstrates how to retrieve a list of all intents configured for a Wit.ai application. It sends a GET request to the '/intents' endpoint with a version parameter.

```bash
curl -XGET 'https://api.wit.ai/intents?v=20240304' \
 -H "Authorization: Bearer $TOKEN"
```
Tokens:
Raw