alpha

Revise artifacts

Save an edited Markdown document as a new version of a document Alpha made; the version it was edited from stays unchanged. Returns the new version.

post/api/v1/alpha/artifacts/revise

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/artifacts/revise
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

revisesArtifactIdstring uuid

The latest version read by read_artifact when editing an existing document; omit only for a new document.

brandKitArtifactIdstring uuid
unbrandedboolean
kind'markdown' | 'csv' required

markdown: a Markdown document. csv: a CSV file to download. Presentations use create_file with format pptx.

titlestring required
deliverableboolean

false for a working file that only another step reads, such as a CSV written for run_analysis or create_file: it folds under the answer and stays out of the person's Files list. Omit it for a document or CSV the person asked for. A new version keeps its file's choice, so omit it with revisesArtifactId.

markdownstring

The document. Required when kind is markdown.

csvstring

The file's text: a header row first, RFC 4180 quoting, one record per line. Required when kind is csv.

idstring required

The ID of any version of a file Alpha made

Response

Success.

artifactIdstring uuid required
kind'markdown' | 'slides' | 'image' | 'audio' | 'video' | 'brand_kit' | 'presentation' | 'spreadsheet' | 'word' | 'pdf' | 'csv' | 'page' required
titlestring required
mediaType'text/markdown' | 'application/vnd.point11.slides+json' | 'image/png' | 'image/jpeg' | 'image/webp' | 'audio/mpeg' | 'audio/wav' | 'video/mp4' | 'video/webm' | 'application/vnd.point11.brand-kit+json' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/pdf' | 'text/csv' | 'text/html' | 'application/vnd.point11.website+json' required
byteLengthinteger required
status'ready'
revisesArtifactIdstring uuid
brandNamestring
slideCountinteger
previewArtifactIdstring uuid
previewFailure'render_failed' | 'invalid_preview' | 'upload_failed'
websitePreviewFailure'capture_failed' | 'upload_failed'
purpose'deliverable' | 'working'

Changes

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