Get Assistant

Get Assistant

Method: GET

Endpoint: https://api.assistable.ai/v2/get-assistant

This endpoint retrieves the full details of an existing AI assistant using its unique ID. Use this to verify current settings or display assistant details in your application.

1. Authorizations

To use this endpoint, you must include your API Key in the Header.

  • Header Name: Authorization

  • Value: Bearer <your_token_here>


2. Query Parameters

Unlike the "Create" endpoint which uses a Body, this request uses Query Parameters (added to the end of the URL).

Field

Type

Required?

Description

assistant_id

string

Yes

The unique ID of the assistant you want to fetch (e.g., asst_12345).


3. Example Request (Code)

Copy the code below to test this endpoint. Note that the assistant_id is passed as a query parameter in the URL.

Bash

curl --request GET \
--url 'https://api.assistable.ai/v2/get-assistant?assistant_id=asst_12345' \
--header 'Authorization: Bearer <token>'

4. Success Response

If the assistant exists, you will receive a 200 status code and the assistant object:

JSON

{
"status": 200,
"data": {
"id": "asst_12345",
"name": "My Support Bot",
"description": "Handles inbound support queries",
"model": "gpt-4",
"voice_id": "voice_abc123",
"created_at": "2023-10-27T10:00:00Z"
}
}

5. Troubleshooting

  • Status 200: Success.

  • Status 401: Unauthorized. Check your Bearer token.

  • Status 404: Not Found. The assistant_id you provided does not exist or has been archived.


Was this article helpful?