Alfa

Agent

Read a document attached to the conversation

POST/v1/agent/read-document

Requires the session token of a signed-in Alfa user as a bearer token.

Request body

  • fileKeystringrequired

    at least 1 characters

  • fileNamestringrequired

    at least 1 characters

  • documentType"resume" | "job_description" | "interview_notes" | "hiring_brief" | "other"

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details