authenticated
agent-documents

Delete Document

delete/agents/documents/{document_id}

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

document_idstring required

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

idstring required
organization_idstring required
created_atstring date-time nullable
updated_atstring date-time nullable
deleted_atstring date-time nullable
vectorized_atstring date-time nullable
titlestring required
giststring nullable
urlstring nullable
status'queued' | 'processing' | 'ready' | 'error' required
type'text' | 'file' | 'link' required
category'pricing' | 'promotional_pricing' | 'membership_details' | 'maintenance_scope' | 'about_us' | 'outreach_script' | 'other'

What a document is about, as opposed to DocumentType's modality.

Mirrors the frontend template picker (document-templates.ts), which is already the set of documents we coach orgs to create. One category per document: the templates partition the content, so base and non-member rates live in pricing while member-only rates live in membership_details, and a consumer requires each category it needs rather than a fuzzy set.

maintenance_scope rather than "maintenance" — maintenance already means recurring service events elsewhere in this schema.

created_by_user_idstring nullable
updated_by_user_idstring nullable
prompt_eval_group_idsstring[]

Changes

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