Get the agent on an Instagram account
Retrieve the agent currently answering on one of the project's Instagram accounts. The response returns the agent's full configuration under agent and that account's chatbot settings under text_chatbot_settings. Use this to confirm which agent is auto-replying on a account before updating or removing the assignment.
curl --request GET \
--url 'https://api.nabrah.ai/api/ext/omni_v2/instagram/get_chatbot' \
--header 'X-API-Key: <your-api-key>'{
"agent": {
"agent_id": "00000000-0000-4000-8000-000000000000",
"project_id": "00000000-0000-4000-8000-000000000000",
"created_by_email": "string",
"created_at": "2026-01-15T12:00:00.000Z",
"last_update": "2026-01-15T12:00:00.000Z",
"name": "string",
"start_first": false,
"first_sentence": "string",
"agent_type": "basic",
"who_are_you": "string",
"goal": "string",
"steps": "string",
"allow_interruptions": false,
"voice": "dania",
"support_data": "string",
"languages": [
"ar"
],
"stack": "latest",
"speech_speed": 0.7,
"variables": [
{
"name": "string",
"type": "string",
"default_value": "string"
}
],
"pre_call_callback": {
"url": "string",
"parameters": [
{
"name": null,
"location": null,
"data_type": null,
"value": null
}
]
},
"post_call_callback": {
"url": "string",
"parameters": [
{
"name": null,
"location": null,
"data_type": null,
"value": null
}
]
},
"post_analysis_callback": {
"url": "string",
"parameters": [
{
"name": null,
"location": null,
"data_type": null,
"value": null
}
]
},
"tools": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string"
}
],
"knowledge_bases": [
{
"id": "00000000-0000-4000-8000-000000000000",
"project_id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"key": "string",
"desc": "string",
"kind": "unstructured",
"document_count": 0,
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z"
}
],
"system_tools": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"config": {},
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z",
"when_to_use": "string"
}
],
"analysis_groups": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string"
}
],
"background_ambient": false,
"background_ambient_volume": 0,
"thinking_sound": false,
"thinking_sound_volume": 0
},
"text_chatbot_settings": {
"can_refer_to_human": false,
"human_emails": [
"string"
],
"name": "string",
"created_at": "2026-01-15T12:00:00.000Z",
"auto_resolve_hours": 0,
"webhook_url": "string",
"has_webhook_hmac_secret": false,
"inbox_ids": [
"00000000-0000-4000-8000-000000000000"
]
}
}Reading the response
agentThe complete configuration of the agent handling Instagram direct messages, including agent_id, name, languages, voice, tools, and callbacks.
text_chatbot_settingsThe settings of this account. name is shared by every account the agent answers on; inbox_ids lists those accounts. webhook_url is the event webhook set on assign; the signing secret is never returned, only has_webhook_hmac_secret.
can_refer_to_humanhuman_emailsauto_resolve_hourswebhook_urlhas_webhook_hmac_secretnameinbox_idscreated_atAssign with POST /api/ext/omni_v2/instagram/assign_chatbot and remove with DELETE /api/ext/omni_v2/instagram/unassign_chatbot.
Reading human_emails
text_chatbot_settings.human_emails comes back in whichever shape it was stored: a list of addresses, a list of objects with hours, or a category map.
Responses are not stripped of nulls, so an hours object can come back carrying start: null or end: null, and a destination that has no window at all can appear as hours: null. Treat all three as always available.
human_emailsChoosing the Instagram account
A project can connect more than one Instagram account. inbox_id selects the account this call works on.
inbox_id is optional; the project's only Instagram account is used.
inbox_id is required and the call returns 400 without it. An id that is not one of the project's Instagram accounts returns 404.
inbox_idList the accounts and their ids with GET /api/ext/omni_v2/instagram/inboxes.
Authorization
X-API-KeystringheaderrequiredYour workspace API key. Create one in the dashboard under API keys.
Query parameters
inbox_idstringThe id of the Instagram account to use, from GET /api/ext/omni_v2/instagram/inboxes.
Use inboxes[].id (a UUID), not the numeric inboxes[].inbox_id. Optional while the project has one Instagram account; required once it has more than one.
Response
Successful Response
application/json
Validation Error
application/json