{"openapi":"3.0.0","paths":{"/search/documents":{"get":{"operationId":"SearchController_documents","parameters":[{"name":"q","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Public API"]}},"/search/recent":{"get":{"operationId":"SearchController_recent","parameters":[{"name":"organizationId","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Public API"]}},"/ai/draft":{"post":{"operationId":"AiController_draft","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDto"}}}},"responses":{"201":{"description":""}},"tags":["Ai","Public API"],"x-token-scope":"draft"}},"/ai/draft/job/{id}":{"get":{"operationId":"AiController_draftJob","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Ai","Public API"],"x-token-scope":"draft"}},"/ai/doc-set/plan":{"post":{"operationId":"AiController_planDocSet","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanDocSetDto"}}}},"responses":{"201":{"description":""}},"tags":["Ai","Public API"],"x-token-scope":"draft"}},"/ai/evaluate":{"post":{"operationId":"AiController_evaluateDocument","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluateDocumentDto"}}}},"responses":{"201":{"description":""}},"tags":["Ai","Public API"],"x-token-scope":"draft"}},"/ai/doc-set/draft":{"post":{"operationId":"AiController_draftDocSet","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDocSetDto"}}}},"responses":{"201":{"description":""}},"tags":["Ai","Public API"],"x-token-scope":"draft"}},"/ai/draft/jobs":{"get":{"operationId":"AiController_draftJobs","parameters":[{"name":"organizationId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Ai","Public API"],"x-token-scope":"draft"}},"/project/doc/{docId}/media":{"post":{"operationId":"DocumentMediaController_upload","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentMedia","Public API"]}},"/project":{"get":{"operationId":"ProjectController_list","parameters":[],"responses":{"200":{"description":""}},"tags":["Project","Public API"]}},"/project/{id}/documents":{"get":{"operationId":"ProjectController_documents","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["Project","Public API"]},"post":{"operationId":"ProjectController_createDocument","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentDto"}}}},"responses":{"201":{"description":""}},"tags":["Project","Public API"]}},"/project/doc/{docId}":{"get":{"operationId":"ProjectController_document","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["Project","Public API"]}},"/project/doc/link-preview/{publicId}":{"get":{"operationId":"ProjectController_docLinkPreview","parameters":[{"name":"publicId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Project","Public API"]}},"/project/doc/by-handle/{publicId}":{"get":{"operationId":"ProjectController_documentByHandle","parameters":[{"name":"publicId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Project","Public API"]}},"/project/doc/{docId}/wp":{"get":{"operationId":"DocumentWpController_getWp","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["DocumentWp","Public API"]},"patch":{"operationId":"DocumentWpController_stageWp","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/wp/media":{"post":{"operationId":"DocumentWpController_uploadMedia","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/wp/pull":{"post":{"operationId":"DocumentWpController_pull","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/wp/publish":{"post":{"operationId":"DocumentWpController_publish","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/wp/push":{"post":{"operationId":"DocumentWpController_push","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/wp/connect-post":{"post":{"operationId":"DocumentWpController_connectPost","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{projectId}/wp/terms":{"post":{"operationId":"DocumentWpController_createTerm","parameters":[{"name":"projectId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{projectId}/wp-import":{"post":{"operationId":"DocumentWpController_importSite","parameters":[{"name":"projectId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentWp","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/wp/schedule":{"get":{"operationId":"PublishScheduleController_get","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["PublishSchedule","Public API"]},"post":{"operationId":"PublishScheduleController_schedule","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["PublishSchedule","Public API"],"x-token-scope":"publish"},"delete":{"operationId":"PublishScheduleController_cancel","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["PublishSchedule","Public API"],"x-token-scope":"publish"}},"/project/doc/{docId}/propose":{"post":{"operationId":"DocumentProposalsController_propose","parameters":[{"name":"docId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["DocumentProposals","Public API"]}},"/project/doc/translations/languages":{"get":{"operationId":"TranslationsController_languages","parameters":[],"responses":{"200":{"description":""}},"tags":["Translations","Public API"]}},"/project/doc/{documentId}/translations":{"get":{"operationId":"TranslationsController_list","parameters":[{"name":"documentId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Translations","Public API"]}}},"info":{"title":"Workover API","description":"The Workover REST API. Authenticate with a personal access token as a bearer token. Every endpoint listed here is reachable with a token; endpoints that are not listed are deliberately session-only and no token can reach them.","version":"1.0.0","contact":{}},"tags":[],"servers":[{"url":"https://api.workover.io"}],"components":{"securitySchemes":{"token":{"scheme":"bearer","bearerFormat":"wk_...","type":"http","description":"A personal access token created in Settings. Some endpoints additionally require the token to hold a scope, shown per endpoint as x-token-scope."}},"schemas":{"CreateDocumentDto":{"type":"object","properties":{}},"DraftDocSetDto":{"type":"object","properties":{}},"DraftDto":{"type":"object","properties":{}},"EvaluateDocumentDto":{"type":"object","properties":{}},"PlanDocSetDto":{"type":"object","properties":{}}}}}