API Overview (Draft)

Draft placeholder — update once the public API surface is stable.

Base information

  • Base URL: https://api.getperspective.ai/v1 (confirm before publishing)
  • Auth: Bearer token (workspace-scoped). Generate tokens in Settings → API.
  • Rate limits: 60 requests/min per token. 429 responses include Retry-After header.

Core resources (planned)

ResourceMethodsDescription
/outlinesGET, POST, PATCHList, create, and update interview outlines.
/agentsGET, POST, PATCHManage concierge/interviewer/evaluator agents.
/conversationsGETFetch transcripts, metadata, trust scores.
/invitesPOSTTrigger invites or send reminders.
/highlightsGET, POSTPublish or retrieve highlight pages.

Sample request

curl https://api.getperspective.ai/v1/outlines \
  -H "Authorization: Bearer $PERSPECTIVE_TOKEN" \
  -H "Content-Type: application/json"

Error model

{
  "error": {
    "code": "outline_not_found",
    "message": "Outline 123 not found in workspace abc"
  }
}

Next steps

  • Add Postman collection + OpenAPI spec.
  • Document pagination/filtering behavior.
  • Include examples for each language SDK once published.