Slack API

Slack is in beta.

Create a Slack app for an Inkbox identity in a workspace configured by your organization. Search retained messages across the identity, or select a workspace connection for live operations and archive management. Start with the Slack guide for installation and runtime behavior. API base URL:

https://inkbox.ai/api/v1/slack

Authenticated requests use your API key:

X-API-Key: YOUR_API_KEY

Access

Operation	Who can call it
List connections; live and retained reads; backfills; messages, files, reactions, pins, and other operations	An organization admin API key, the Inkbox Console, or a claimed agent-scoped API key for the owning identity
List saved provisioning-workspace metadata; save workspace credentials	Any organization member in the Console, an organization admin API key, or a claimed agent-scoped API key, within their organization
Prepare the app; start installation	Any organization member in the Console, an organization admin API key, or a claimed agent-scoped API key for the owning identity
Disconnect; change archive settings or delete an archive	An organization admin API key or the Inkbox Console

Claimed agent keys can reuse their organization’s saved workspaces, but can prepare, install, and use apps only for their own identity. Workspace metadata never includes saved credentials. Connections do not grant access outside the owning identity. Workspace approval, channel membership, granted Slack permissions, and Slack rate limits apply to every live operation. Unclaimed agent keys cannot use these endpoints. Retained reads also check current conversation access. Slack Connect uses the selected connection’s permissions. Slack does not apply email or phone contact allow/block rules to its conversations.

Endpoints

All paths below are relative to the API base URL.

Method	Path	Reference
GET	`/search`	Search across workspaces
GET	`/provisioning-workspaces`	List saved workspaces
POST	`/provisioning-workspaces`	Save workspace credentials
GET	`/connections`	List connections
POST	`/applications/setup`	Prepare an identity app
POST	`/installations`	Start browser installation
POST	`/connections/{connection_id}/disconnect`	Disconnect
GET	`/connections/{connection_id}/conversations`	List conversations
POST	`/connections/{connection_id}/conversations`	Open a DM
GET	`/connections/{connection_id}/conversations/{conversation_id}`	Get conversation
GET	`/connections/{connection_id}/conversations/{conversation_id}/messages`	Read messages or replies
POST	`/connections/{connection_id}/messages`	Send message
GET	`/connections/{connection_id}/actions/by-key`	Recover action by key
GET	`/connections/{connection_id}/actions/{action_id}`	Read action status
GET	`/connections/{connection_id}/files/{file_id}`	Read file metadata
GET	`/connections/{connection_id}/files/{file_id}/content`	Download file
POST	`/connections/{connection_id}/files`	Upload file
GET	`/connections/{connection_id}/capabilities`	Capabilities
GET	`/connections/{connection_id}/users`	List users
GET	`/connections/{connection_id}/users/{user_id}`	Get user
GET	`/connections/{connection_id}/conversations/{conversation_id}/members`	List members
GET	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}`	Get message
GET	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}/context`	Read context
GET	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}/permalink`	Get message link
PATCH	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}`	Edit message
DELETE	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}`	Delete message
GET	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}/reactions`	Read reactions
POST	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}/reactions`	Add reaction
DELETE	`/connections/{connection_id}/conversations/{conversation_id}/messages/{message_ts}/reactions/{name}`	Remove reaction
GET	`/connections/{connection_id}/conversations/{conversation_id}/pins`	Read pins
POST	`/connections/{connection_id}/conversations/{conversation_id}/pins`	Pin message
DELETE	`/connections/{connection_id}/conversations/{conversation_id}/pins/{message_ts}`	Unpin message
POST	`/connections/{connection_id}/conversations/{conversation_id}/join`	Join conversation
POST	`/connections/{connection_id}/conversations/{conversation_id}/leave`	Leave conversation
POST	`/connections/{connection_id}/conversations/{conversation_id}/processing-status`	Set processing status
GET	`/connections/{connection_id}/operations/{operation_id}`	Get operation
GET	`/connections/{connection_id}/archive/settings`	Read retention settings
PATCH	`/connections/{connection_id}/archive/settings`	Set message retention
GET	`/connections/{connection_id}/archive/messages`	Read retained messages
GET	`/connections/{connection_id}/archive/search`	Search one workspace
POST	`/connections/{connection_id}/archive/backfill`	Import history
GET	`/connections/{connection_id}/archive/coverage`	Inspect coverage
DELETE	`/connections/{connection_id}/archive`	Delete archive

Common errors and limits

Status	Meaning
`401`	Authentication is missing or invalid.
`403`	Your key cannot perform the operation, or the agent lacks conversation access.
`404`	The identity, connection, action, conversation, or file is unavailable to the caller.
`409`	State changed, reauthorization is required, an idempotency key conflicts, archive cleanup is unfinished for a backfill, or installation state prevents the request.
`410`	An installation link is expired, consumed, revoked, or otherwise unavailable.
`413`	The request body or downloaded file exceeds its size limit.
`422`	The input is invalid or an unsupported file type was requested.
`429`	A Slack request, installation attempt, or related request was rate-limited. Honor `Retry-After` when present.
`502`	Slack could not complete a live request. Inspect the returned error code.
`503`	Installation or a live operation is temporarily unavailable. Honor `Retry-After` when present.

An incompatible reuse of an idempotency key returns 409 with detail.error: "idempotency_key_reused". The SDKs expose the corresponding typed idempotency-conflict error. Do not retry it as a transient failure. Read one page at a time. The API does not promise a fixed requests-per-minute allowance or complete workspace history. Conversation objects and message objects contain the supported fields available from Slack, not a fixed set of populated properties. There are no Slack delivery/read receipts or semantic-search endpoints. Retained search covers captured message text, not every message or file in the workspace. Native processing status depends on Slack app and workspace support.

Agent signup API

Agent identity API

Agent2Agent API

Message retries

Mail API

Phone API

iMessage API

Webhooks API

Tunnels API

Contacts API

Notes API

Vault API

Billing API

Slack API

Access

Endpoints

Common errors and limits

​Access

​Endpoints

​Common errors and limits

Access

Endpoints

Common errors and limits