Workspaces

Delete a workspace file

Deletes the file, its outputs, and its index and graph entries, as a file_delete job. Free.

delete/v1/workspaces/{id}/files/{file_id}

Request

Path parameters

idstring required

The workspace's workspace_id.

file_idstring required

The file's file_id.

Query parameters

wait_secondsinteger

Hold the request open until the job finishes, up to this many seconds. 0 (default) returns at once; a value above 60 waits 60.

Headers

Idempotency-Keystring

Up to 200 characters, unique per account. Retry with the same key and body to get the same job instead of a second one.

Response

The job, finished within wait_seconds.

job_idstring uuid required
kindstring required

The document service's job kind, such as ingestion, reconciliation, kg_build, intelligent_search (automatic search), automatic_agent (QA), file_replace, file_delete or workspace_delete.

status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
workspace_idstring
resultunknown

Changes

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