AI Assistant API

APIs related to AI Assistant management.

AI Assistant

This section describes APIs related to AI Assistant management.

1. Get Assistants

Retrieve a list of AI assistants with optional parameters like limit and sorting.

  • Endpoint: GET https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants?limit=2&sort=desc

  • Headers:

    • x-temp-token: Your token

    • Content-Type: application/json

  • Example:

    curl --location 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants?limit=2&sort=desc' \
--header 'x-temp-token: api_648b936b-cd1d-4553-bb30-7124d3910100' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0'

2. Create Assistant

Create a new AI assistant with specified attributes such as name, description, instructions, and metadata.

  • Endpoint: POST https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants

  • Headers:

    • x-temp-token: Your token

    • Content-Type: application/json

    • Authorization: Bearer Your token

  • Body:

    {
    "name": "testing assistant 6",
    "description": "description",
    "instructions": "instructions",
    "file_ids": [],
    "metadata": {
        "key_1": "value_1"
    }
}

  • Example:

    curl --location 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0' \
--header 'x-temp-token: api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--data '{
    "name": "testing assistant 6",
    "description": "description",
    "instructions": "instructions",
    "file_ids": [],
    "metadata": {
        "key_1": "value_1"
    }
}'

3. Update Assistant

Update the details of an existing AI assistant by its ID.

  • Endpoint: PUT https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants/{assistant_id}

  • Headers:

    • x-temp-token: Your token

    • Content-Type: application/json

    • Authorization: Bearer Your token

  • Body:

    {
    "name": "testing assistant 15",
    "description": "updated description",
    "instructions": "updated instructions",
    "file_ids": [],
    "metadata": {
        "key_2": "value_2"
    }
}

  • Example:

    curl --location --request PUT 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants/asst_1r0G0F5E92HN8Q3mw91Rrbxq' \
--header 'x-temp-token: api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0' \
--data '{
    "name": "testing assistant 15",
    "description": "updated description",
    "instructions": "updated instructions",
    "file_ids": [],
    "metadata": {
        "key_2": "value_2"
    }
}'

4. Delete Assistant

Delete a specific AI assistant by its ID.

  • Endpoint: DELETE https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants/{assistant_id}

  • Headers:

    • x-temp-token: Your token

  • Example:

    curl --location --request DELETE 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistants/asst_1r0G0F5E92HN8Q3mw91Rrbxq' \
--header 'x-temp-token: api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0' \
--header 'Authorization: Bearer api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1'

5. Create Assistant App

Create a new AI Assistant app with specified attributes.

  • Endpoint: POST https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistant_apps

  • Headers:

    • x-temp-token: Your token

    • Content-Type: application/json

  • Body:

    {
    "name": "testing assistant 12",
    "description": "description",
    "instructions": "instructions",
    "file_ids": [],
    "metadata": {
        "key_1": "value_1"
    },
    "workflow_name": "workflow test 12",
    "credential_id": 0,
    "credential_name": "placeholder",
    "mode": "advanced"
}

  • Example:

    curl --location 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistant_apps' \
--header 'x-temp-token: api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'Content-Type: application/json' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0' \
--data '{
    "name": "testing assistant 12",
    "description": "description",
    "instructions": "instructions",
    "file_ids": [],
    "metadata": {
        "key_1": "value_1"
    },
    "workflow_name": "workflow test 12",
    "credential_id": 0,
    "credential_name": "placeholder",
    "mode": "advanced"
}'

6. Update Assistant App

Update the details of an existing Assistant app by its ID.

  • Endpoint: PUT https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistant_apps/{app_id}

  • Headers:

    • x-temp-token: Your token

    • Content-Type: application/json

  • Body:

    {
    "name": "testing assistant 15",
    "description": "updated description",
    "instructions": "updated instructions",
    "file_ids": [],
    "metadata": {},
    "workflow_name": "workflow test 15",
    "credential_id": 0,
    "credential_name": "placeholder",
    "mode": "advanced"
}

  • Example:

    curl --location --request PUT 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistant_apps/asst_X8JHZyPfapRrUEElNO6H7YD4' \
--header 'x-temp-token: api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'Content-Type: application/json' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0' \
--data '{
    "name": "testing assistant 15",
    "description": "updated description",
    "instructions": "updated instructions",
    "file_ids": [],
    "metadata": {},
    "workflow_name": "workflow test 15",
    "credential_id": 0,
    "credential_name": "placeholder",
    "mode": "advanced"
}'

7. Delete Assistant App

Delete a specific Assistant app by its ID.

  • Endpoint: DELETE https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistant_apps/{app_id}

  • Headers:

    • x-temp-token: Your token

    • Content-Type: application/json

  • Example:

    curl --location --request DELETE 'https://app-gateway.dev.imbrace.co/journeys/v2/ai/assistant_apps/asst_X8JHZyPfapRrUEElNO6H7YD4' \
--header 'x-temp-token: api_9fd1566e-c85b-4d31-90d1-e88ac5bfcfc1' \
--header 'Content-Type: application/json' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:141.0) Gecko/20100101 Firefox/141.0' \
--data ''

PreviousGetting StartedNextChannels API

Last updated