Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

Threads

Every threads endpoint, generated from the API's own schemas.

List threads

get/api/v1/threads

Parameters

  • limitnumber
  • cursordate-time

Responses

  • 200A page of threads.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/threads \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json

Update a thread

patch/api/v1/threads/{id}

Its status and who owns it — the state a conversation carries.

Parameters

  • idstringrequired

Body

  • statusenum

    open · waiting · resolved · human_review

  • owner_typeenum

    human · automation · agent

Responses

  • 200The thread.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/threads/{id} \
  -X PATCH \
  -H "Authorization: Bearer $PIDGEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Generated · public/openapi.json