TEteaflask
authed

List doc requests

The review inbox's doc requests, newest first: each asks an agent to draft a new doc for a member to review. Prompt, status and the drafted doc's id — read the draft itself with get_doc_request. A full page means more may exist.

get/api/v1/doc-requests

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/doc-requests
  • Auth
    none declared

Query parameters

before_created_atstring date-time nullable

With before_id: the last row of the previous page's created_at, to read the next page.

before_idstring uuid nullable

With the sort cursor: the last row of the previous page's id.

limitinteger

The most doc requests to return.

Response

Successful Response

idstring uuid required

The doc request's id.

organization_idstring uuid required

The organization that owns the request.

promptstring required

What the doc was requested to cover.

status'queued' | 'working' | 'ready_for_review' | 'approved' | 'dismissed' | 'failed' | 'unfunded' required
errorstring nullable required

Why the request failed, in a sentence; null unless it failed.

requested_by_user_idstring uuid required

The member who asked.

requested_bystring nullable required

That member's name, or their email when they have no name.

doc_idstring uuid nullable required

The doc the draft was written into; null until a draft exists.

created_atstring date-time required

When the request was made.

updated_atstring date-time required

When the request last changed.

Changes

No recorded changes to this operation across all 1 revision of this API.