{"openapi":"3.1.0","info":{"title":"Paximal Project Intake API","version":"1.0.0","description":"Create, optionally upload to Box, then submit. Only a configured API key is required. Deployment must enable intake."},"servers":[{"url":"https://next.paximal.com","description":"Use your enabled Paximal deployment"}],"security":[{"ApiKey":[]}],"paths":{"/api/v1/projects":{"post":{"operationId":"createProject","summary":"Create a project and get Box upload credentials","requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProject"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectWithUpload"}}}},"400":{"description":"Invalid fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Reference exists or storage unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Body too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"JSON required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Disabled or dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Creates an IDF workspace. The patent attorney selects the patent agent later in Paximal; callers do not select an agent."}},"/api/v1/projects/{project_id}":{"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"operationId":"getProject","summary":"Recover a draft and refresh its upload credentials","responses":{"200":{"description":"Owned intake project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectWithUpload"}}}},"400":{"description":"Invalid fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Reference exists or storage unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Body too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"JSON required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Disabled or dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/projects/{project_id}/submit":{"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"operationId":"submitProject","summary":"Mark ready without starting processing","description":"No body required. Repeating submit preserves its timestamp. Documents are optional. Projects begin at the IDF input stage with uploaded files ready for generation. Submission does not run IDF generation.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Ready","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Invalid fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Reference exists or storage unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Body too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"JSON required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Disabled or dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","description":"Paximal Clerk user API key; projects:write for create, submit and GET (which issues upload access)."}},"schemas":{"CreateProject":{"type":"object","additionalProperties":false,"properties":{"project_reference":{"type":"string","minLength":1,"maxLength":100,"description":"Optional account-unique reference. Generated when omitted; comparison is case-insensitive after trimming."},"invention_name":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":20000},"entity_name":{"type":"string","maxLength":200},"entity_type":{"type":"string","enum":["company","individual"]},"inventors":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"external_id":{"type":"string","minLength":1,"maxLength":200}}},"Project":{"type":"object","required":["project_id","project_reference","status","submitted_at"],"properties":{"project_reference":{"type":"string","minLength":1,"maxLength":100,"description":"Optional account-unique reference. Generated when omitted; comparison is case-insensitive after trimming."},"invention_name":{"type":["string","null"],"maxLength":200},"description":{"type":["string","null"],"maxLength":20000},"entity_name":{"type":["string","null"],"maxLength":200},"entity_type":{"type":["string","null"],"enum":["company","individual",null]},"inventors":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"external_id":{"type":["string","null"],"minLength":1,"maxLength":200},"project_id":{"type":"string"},"status":{"type":"string","enum":["draft","ready"]},"submitted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"ProjectWithUpload":{"allOf":[{"$ref":"#/components/schemas/Project"},{"type":"object","required":["upload"],"properties":{"upload":{"oneOf":[{"$ref":"#/components/schemas/BoxUpload"},{"type":"null"}]}}}]},"BoxUpload":{"type":"object","required":["url","token","folder_id","expires_at"],"properties":{"url":{"type":"string","format":"uri"},"token":{"type":"string","description":"Short-lived base_upload token scoped to the project input folder."},"folder_id":{"type":"string"},"expires_at":{"type":"string","format":"date-time"}}},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"project_id":{"type":"string","description":"Existing owner project on duplicate reference, when known."}}},"request_id":{"type":"string"}}}}}}