Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Capy threads API

The threads API from Capy — 8 operation(s) for threads.

Capy threads API is one of 12 APIs that Capy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include threads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 9 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://capy.ai/api.

9 operations 8 paths 13 schemas 4 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://capy.ai/api/v1/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Capy threads API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API token (capyxxxx). Generate at capy.ai/settings/tokens

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

threads 9
GET
/v1/threads
List threads
listThreads 16 params → 200401403404422500
POST
/v1/threads
Create and start thread
createAndStartThread body → 200401403404422500
GET
/v1/threads/{threadId}
Get thread
getThread 1 param → 200401403404422500
POST
/v1/threads/{threadId}/stop
Stop thread
stopThread 1 param → 200401403404409422429500
POST
/v1/threads/{threadId}/archive
Archive thread
archiveThread 1 param body → 200401403404422500
POST
/v1/threads/{threadId}/unarchive
Unarchive thread
unarchiveThread 1 param body → 200401403404422500
GET
/v1/threads/{threadId}/session-token
Get session token
getThreadSessionToken 1 param → 200401403404410422500
POST
/v1/threads/{threadId}/message
Send thread message
sendThreadMessage 1 param body → 200401403404409422429500
GET
/v1/threads/{threadId}/messages
List thread messages
listThreadMessages 3 params → 200401403404422500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CreateThreadBody (15 properties), ThreadListItem (15 properties), CreateThreadResponse (12 properties), SendThreadMessageBody (12 properties). Each schema is shown below with its type and property counts.

StopThreadResponse
object
2 properties 2 required
SendThreadMessageBody
object
12 properties 1 required
ListThreadsResponse
object
3 properties 3 required
ErrorResponse
object
1 property 1 required
UnarchiveThreadBody
object
1 property
ArchiveThreadResponse
object
2 properties 2 required
SessionTokenResponse
object
3 properties 3 required
ListMessagesResponse
object
3 properties 3 required
ThreadListItem
object
15 properties 15 required
ArchiveThreadBody
object
1 property
CreateThreadResponse
object
12 properties 11 required
SendMessageResponse
object
5 properties 2 required
CreateThreadBody
object
15 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capy-threads-api-openapi.yml Raw ↑

Other APIs Capy publishes across the network.

Capy automations API
Capy browser-snapshots API
Capy environment-variables API
Capy models API
Capy projects API
Capy sessions API
Capy setup API
Capy snapshots API
Capy tags API
Capy tasks API
Capy usage API