API Reference

The Pimsy API is a JSON HTTP interface over the agent runtime. Everything the product does — tasks, tools, memory, artifacts — is reachable through it.

Base URL and versioning#

Base URL

https://api.pimsy.ai

Current version

v1

Content type

application/json; charset=utf-8

Authentication

Bearer token (workspace-scoped API key)

Idempotency

Idempotency-Key header on all POST requests

Timestamps

RFC 3339, always UTC

Identifiers

Prefixed opaque strings (task_, run_, art_)

Authentication#

curl https://api.pimsy.ai/v1/tasks \
  -H "Authorization: Bearer $PIMSY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{ "objective": "Summarize yesterday'"'"'s deployment failures." }'

Resource map#

Pagination#

List endpoints use cursor pagination. Pass limit (default 25, max 100) and after. Responses include has_more and next_cursor.

{
  class="tok-str">"object": class="tok-str">"list",
  class="tok-str">"data": [ { class="tok-str">"id": class="tok-str">"task_8fk21", class="tok-str">"status": class="tok-str">"completed" } ],
  class="tok-str">"has_more": true,
  class="tok-str">"next_cursor": class="tok-str">"cur_9dk1Ma"
}