{"items":[{"type":"link","label":"Hypatos REST API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Hypatos REST API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"API EU","url":"https://api.cloud.hypatos.ai/v2"},{"description":"API US","url":"https://api.cloud.hypatos.com/v2"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Hypatos REST API (2.79.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Hypatos API is organized around REST. The majority of the endpoints provide CRUD"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"functionality for resources. The API is also exposing Intent Resources which mimic user intents"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Hypatos API uses "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc6749#section-4.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Client Credential Grant"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to authenticate requests. Before making any requests to any endpoint a client must authenticate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the authorization server and requests an access token from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/requestAccessToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  POST /auth/token HTTP/1.1\n  Host: api.cloud.hypatos.ai\n  Content-Type: application/x-www-form-urlencoded\n  Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=\n\n  grant_type=client_credentials\n","language":"sh"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  POST /auth/token HTTP/1.1\n  Host: api.cloud.hypatos.ai\n  Content-Type: application/x-www-form-urlencoded\n  Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=\n\n  grant_type=client_credentials\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id:client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" encoded as explained in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC Client Password section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the authorization server authenticated the client successfully, an access token is issued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example successful response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  HTTP/1.1 200 OK\n  Content-Type: application/json;charset=UTF-8\n  Cache-Control: no-store\n  Pragma: no-cache\n\n  {\n    \"access_token\": \"mF_9.B5f-4.1JqM\",\n    \"expires_in\": 86400,\n    \"scope\": \"enrichment.write files.read\",\n    \"token_type\": \"Bearer\",\n  }\n","language":"sh"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  HTTP/1.1 200 OK\n  Content-Type: application/json;charset=UTF-8\n  Cache-Control: no-store\n  Pragma: no-cache\n\n  {\n    \"access_token\": \"mF_9.B5f-4.1JqM\",\n    \"expires_in\": 86400,\n    \"scope\": \"enrichment.write files.read\",\n    \"token_type\": \"Bearer\",\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This token can be used to authenticate the requests to API endpoints by sending a Bearer token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header. The following example demonstrates how to use the access token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to retrieve a list of documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  GET /v2/documents HTTP/1.1\n  Host: api.cloud.hypatos.ai\n  Authorization: Bearer mF_9.B5f-4.1JqM\n","language":"sh"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  GET /v2/documents HTTP/1.1\n  Host: api.cloud.hypatos.ai\n  Authorization: Bearer mF_9.B5f-4.1JqM\n"},"children":[]}]}]}],"sectionId":"/openapi/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes to this API are released regularly. We use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://semver.org/spec/v2.0.0.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Semantic Versioning 2.0.0"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheme for versioning so that the clients can identify any backward-incompatible changes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"easily. Briefly summarized one can say, if the MAJOR version of the new API version didn't"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"change you can expect the new version to be backward-compatible."},"children":[]}]}]}]}],"sectionId":"/openapi/section/versioning"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to maximise the stability of our API, we institue rate limits for all of API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoints. Clients who send too many requests over a given period of time will see error"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responses that show up as status code "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you see error responses with status code 429, it means you exhausted your current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quota and need to withhold from sending further requests until the quota is reset. We"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encourage you not to wait until you get a 429 error but to monitor your quota in each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request. In each response you receive from the API, you will find HTTP headers providing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the details about your current quota. Here is the list of the HTTP headers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-ratelimit-limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates the quota associated to the client in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current time-window followed by the description of the quota policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-ratelimit-remaining"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates the number of remaining requests in the current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time-window"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-ratelimit-reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates the number of seconds until quota reset of the current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time-window"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that IETF is currently in the process of publishing a standard for these"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"headers. Please explore the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"draft"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A basic technique to gracefully handle rate limits is watch for your quota permanently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and increase the time between your request as the quota is decreasing. To recover from a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 error you need a retry mechanism following an exponential backoff schedule."},"children":[]}]}]}]}],"sectionId":"/openapi/section/rate-limits"}]}]}},{"type":"link","label":"Introduction","link":"/openapi/section/introduction","routeSlug":"/openapi/section/introduction","content":null},{"type":"link","label":"Versioning","link":"/openapi/section/versioning","routeSlug":"/openapi/section/versioning","content":null},{"type":"link","label":"Rate limits","link":"/openapi/section/rate-limits","routeSlug":"/openapi/section/rate-limits","content":null},{"type":"group","label":"Authorization","link":"/openapi/authorization","routeSlug":"/openapi/authorization","items":[{"label":"Request an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/authorization/requestaccesstoken","routeSlug":"/openapi/authorization/requestaccesstoken","metadata":{"seo":{"title":"Request an access token","description":"Request an access token using your client credentials"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestAccessToken","name":"Request an access token","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request an access token using your client credentials"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AccessTokenRequest"}},"schemaId":"components/schemas/AccessTokenRequest","pointer":"/paths/~1auth~1token/post/requestBody","description":"Access token request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AccessTokenRequest"}},"responseCodes":["200","401","429"],"pointer":"/auth/token","href":"authorization/requestaccesstoken","openApiOperationId":"requestAccessToken","summary":"Request an access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AccessTokenRequest","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AccessTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access token provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenResponse"}},"schemaId":"components/schemas/AccessTokenResponse"},{"code":"401","description":"Invalid Client Credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccessTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenResponse"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorization/requestaccesstoken"}],"panels":[]}]},"httpPath":"/auth/token"}],"content":{"contentType":"group","meta":{"name":"Authorization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorization","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints for handling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc6749#section-4.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Client Credentials Grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/token","summary":"Request an access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorization/requestaccesstoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/openapi/files","routeSlug":"/openapi/files","items":[{"label":"Upload a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/files/uploadfile","routeSlug":"/openapi/files/uploadfile","metadata":{"seo":{"title":"Upload a file","description":"This endpoint allows a client to upload a binary file. The id returned in theresponse represents the file in Hypatos systems. It can be used in other endpoints,for example to initiate processing of the file to create a document holding captureddata, or to include the file in a case."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadFile","name":"Upload a file","isWebhook":false,"pointer":"/paths/~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows a client to upload a binary file. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response represents the file in Hypatos systems. It can be used in other endpoints,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example to initiate processing of the file to create a document holding captured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data, or to include the file in a case."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["files.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Hy-Filename","in":"header","schemaId":"schema_1","description":"Optional name of the file to be stored along with the content."}],"pointer":"/paths/~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/pdf","image/jpeg","image/png","image/tiff","application/xml","text/xml","application/json","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","text/csv","text/html"],"mediaTypeSchemas":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"},"image/jpeg":{"schemaId":"components/schemas/BinaryFile"},"image/png":{"schemaId":"components/schemas/BinaryFile"},"image/tiff":{"schemaId":"components/schemas/BinaryFile"},"application/xml":{"schemaId":"components/schemas/BinaryFile"},"text/xml":{"schemaId":"components/schemas/BinaryFile"},"application/json":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.presentationml.presentation":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schemaId":"components/schemas/BinaryFile"},"text/csv":{"schemaId":"components/schemas/BinaryFile"},"text/html":{"schemaId":"components/schemas/BinaryFile"}},"schemaId":"components/schemas/BinaryFile","pointer":"/paths/~1files/post/requestBody","description":"Payload of the file"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Hy-Filename","in":"header","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["files.write"]}],"requestBody":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"},"image/jpeg":{"schemaId":"components/schemas/BinaryFile"},"image/png":{"schemaId":"components/schemas/BinaryFile"},"image/tiff":{"schemaId":"components/schemas/BinaryFile"},"application/xml":{"schemaId":"components/schemas/BinaryFile"},"text/xml":{"schemaId":"components/schemas/BinaryFile"},"application/json":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.presentationml.presentation":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schemaId":"components/schemas/BinaryFile"},"text/csv":{"schemaId":"components/schemas/BinaryFile"},"text/html":{"schemaId":"components/schemas/BinaryFile"}},"responseCodes":["201","400","429"],"pointer":"/files","href":"files/uploadfile","openApiOperationId":"uploadFile","summary":"Upload a file"},"definitionSamples":[{"lang":"curl","label":"curl","source":"curl -i -X POST https://api.cloud.hypatos.ai/v2/files \\\n  -H \"Authorization: Bearer <YOUR_TOKEN_HERE>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"X-Hy-Filename: invoice.pdf\" \\\n  --data-binary @/path/to/your/document.pdf\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BinaryFile","mediaTypes":["application/pdf","image/jpeg","image/png","image/tiff","application/xml","text/xml","application/json","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","text/csv","text/html"],"mediaTypeSchemas":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"},"image/jpeg":{"schemaId":"components/schemas/BinaryFile"},"image/png":{"schemaId":"components/schemas/BinaryFile"},"image/tiff":{"schemaId":"components/schemas/BinaryFile"},"application/xml":{"schemaId":"components/schemas/BinaryFile"},"text/xml":{"schemaId":"components/schemas/BinaryFile"},"application/json":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.presentationml.presentation":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schemaId":"components/schemas/BinaryFile"},"text/csv":{"schemaId":"components/schemas/BinaryFile"},"text/html":{"schemaId":"components/schemas/BinaryFile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"File uploaded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadResponse"}},"schemaId":"components/schemas/UploadResponse"},{"code":"400","description":"Content type is not supported","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/UploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/uploadfile"}],"panels":[]}]},"httpPath":"/files"},{"label":"Download a file by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/files/retrievefile","routeSlug":"/openapi/files/retrievefile","metadata":{"seo":{"title":"Download a file by id","description":"Download the content of a file with the given identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFile","name":"Download a file by id","isWebhook":false,"pointer":"/paths/~1files~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a file by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download the content of a file with the given identifier.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["files.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"File id to download","required":true}],"pointer":"/paths/~1files~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["files.read"]}],"responseCodes":["200","404","429"],"pointer":"/files/{id}","href":"files/retrievefile","openApiOperationId":"retrieveFile","summary":"Download a file by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Binary content of a file","mediaType":"application/pdf","mediaTypes":["application/pdf","image/jpeg","image/png","image/tiff","application/xml","text/xml","application/json","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","text/csv","text/html"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"},"image/jpeg":{"schemaId":"components/schemas/BinaryFile"},"image/png":{"schemaId":"components/schemas/BinaryFile"},"image/tiff":{"schemaId":"components/schemas/BinaryFile"},"application/xml":{"schemaId":"components/schemas/BinaryFile"},"text/xml":{"schemaId":"components/schemas/BinaryFile"},"application/json":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.presentationml.presentation":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schemaId":"components/schemas/BinaryFile"},"text/csv":{"schemaId":"components/schemas/BinaryFile"},"text/html":{"schemaId":"components/schemas/BinaryFile"}},"schemaId":"components/schemas/BinaryFile","headers":{"X-Hy-Filename":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a filename was provided during the file upload via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-Filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header, it will be returned in this header."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"404","description":"No file with given identifier exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1files~1{id}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1files~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BinaryFile","mediaTypes":["application/pdf","image/jpeg","image/png","image/tiff","application/xml","text/xml","application/json","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","text/csv","text/html"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"},"image/jpeg":{"schemaId":"components/schemas/BinaryFile"},"image/png":{"schemaId":"components/schemas/BinaryFile"},"image/tiff":{"schemaId":"components/schemas/BinaryFile"},"application/xml":{"schemaId":"components/schemas/BinaryFile"},"text/xml":{"schemaId":"components/schemas/BinaryFile"},"application/json":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.presentationml.presentation":{"schemaId":"components/schemas/BinaryFile"},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schemaId":"components/schemas/BinaryFile"},"text/csv":{"schemaId":"components/schemas/BinaryFile"},"text/html":{"schemaId":"components/schemas/BinaryFile"}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1files~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/retrievefile"}],"panels":[]}]},"httpPath":"/files/{id}"},{"label":"Retrieve file metadata by id","deprecated":false,"httpVerb":"head","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/files/retrievefilemetadata","routeSlug":"/openapi/files/retrievefilemetadata","metadata":{"seo":{"title":"Retrieve file metadata by id","description":"Returns the metadata of a file with the given identifier without transferring its content.The response has no body; metadata is conveyed in response headers:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFileMetadata","name":"Retrieve file metadata by id","isWebhook":false,"pointer":"/paths/~1files~1{id}/head","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve file metadata by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the metadata of a file with the given identifier without transferring its content."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response has no body; metadata is conveyed in response headers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - media type of the stored file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - size of the file content in bytes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-Filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - URL-encoded filename, present only if provided during upload"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["files.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"File id to retrieve metadata for","required":true}],"pointer":"/paths/~1files~1{id}/head/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"HEAD","path":"/files/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["files.read"]}],"responseCodes":["200","404","429"],"pointer":"/files/{id}","href":"files/retrievefilemetadata","openApiOperationId":"retrieveFileMetadata","summary":"Retrieve file metadata by id"},"definitionSamples":[{"lang":"curl","label":"curl","source":"curl -I https://api.cloud.hypatos.ai/v2/files/<FILE_ID> \\\n  -H \"Authorization: Bearer <YOUR_TOKEN_HERE>\"\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File exists. Headers describe the file; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header holds the media"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of the stored file. No response body is returned."},"children":[]}]}]}],"headers":{"Content-Length":{"description":"Size of the file content in bytes.","schema":{"type":"integer","format":"int64"}},"X-Hy-Filename":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a filename was provided during the file upload via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-Filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header, it will be returned in this header."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"404","description":"No file with given identifier exists. No response body is returned."},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1files~1{id}/head/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/retrievefilemetadata"}],"panels":[]}]},"httpPath":"/files/{id}"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for management of files"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files","summary":"Upload a file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/uploadfile","deprecated":false},{"title":"/files/{id}","summary":"Download a file by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/retrievefile","deprecated":false},{"title":"/files/{id}","summary":"Retrieve file metadata by id","prefix":{"name":"head","color":"head"},"badges":[],"link":"/files/retrievefilemetadata","deprecated":false}]}]}]}]}},{"type":"group","label":"Documents","link":"/openapi/documents","routeSlug":"/openapi/documents","items":[{"label":"Retrieve a list of documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentslist","routeSlug":"/openapi/documents/documentslist","metadata":{"seo":{"title":"Retrieve a list of documents","description":"Retrieve a list of documents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentsList","name":"Retrieve a list of documents","isWebhook":false,"pointer":"/paths/~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of documents."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_5","description":"Project ids to to find items by. If ommitted, items from all existing projects are returned."},{"name":"offset","in":"query","schemaId":"schema_6","description":"A zero-based offset of the first item in the data collection to return."},{"name":"limit","in":"query","schemaId":"schema_7","description":"Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used."},{"name":"sort","in":"query","schemaId":"schema_8","description":"The field to sort reponse items by."},{"name":"state","in":"query","schemaId":"schema_9","description":"Used to retrieve documents that are in specific states only. Multiple states can be used for this filtering. By default, documents in all states are returned."},{"name":"fileId","in":"query","schemaId":"schema_2","description":"File identifier to retrieve documents that were created from that file"},{"name":"caseId","in":"query","schemaId":"schema_2","description":"Case identifier to retrieve documents that were created for that case."}],"pointer":"/paths/~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":false,"schemaId":"schema_5","style":"form","explode":true},{"name":"offset","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"schemaId":"schema_7"},{"name":"sort","in":"query","required":false,"schemaId":"schema_8"},{"name":"state","in":"query","required":false,"schemaId":"schema_9","style":"form","explode":true},{"name":"fileId","in":"query","required":false,"schemaId":"schema_2"},{"name":"caseId","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.read"]}],"responseCodes":["200","400","429"],"pointer":"/documents","href":"documents/documentslist","openApiOperationId":"documentsList","summary":"Retrieve a list of documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of documents","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentsListResponse"}},"schemaId":"components/schemas/DocumentsListResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1documents/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/InvalidSortDefinition"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1documents/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/InvalidSortDefinition"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentsListResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1documents/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/InvalidSortDefinition"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1documents/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1documents/get/responses/400/content/application~1json/examples/InvalidSortDefinition"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentslist"}],"panels":[]}]},"httpPath":"/documents"},{"label":"Request processing of a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/processfileintodocument","routeSlug":"/openapi/documents/processfileintodocument","metadata":{"seo":{"title":"Request processing of a file","description":"Request a processing of a file that was previously uploaded.The fileId in the request body is representing the identifier of the file that was returned by the upload endpoint.As a result of this request a document will be created and its identifier will be returned in the response.The projectId in the request body is an identifier of the project to create the document in."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processFileIntoDocument","name":"Request processing of a file","isWebhook":false,"pointer":"/paths/~1documents~1process-file/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request processing of a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request a processing of a file that was previously uploaded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body is representing the identifier of the file that was returned by the upload endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a result of this request a document will be created and its identifier will be returned in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body is an identifier of the project to create the document in."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessFileRequest"}},"schemaId":"components/schemas/ProcessFileRequest","pointer":"/paths/~1documents~1process-file/post/requestBody","description":"Payload for processing the given file"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/process-file","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessFileRequest"}},"responseCodes":["202","400","404","429"],"pointer":"/documents/process-file","href":"documents/processfileintodocument","openApiOperationId":"processFileIntoDocument","summary":"Request processing of a file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ProcessFileRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessFileRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Processing accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessingAccepted"}},"schemaId":"components/schemas/ProcessingAccepted"},{"code":"400","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1process-file/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ProcessingAccepted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessingAccepted"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1process-file/post/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/processfileintodocument"}],"panels":[]}]},"httpPath":"/documents/process-file"},{"label":"Retrieve a document by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentsgetbyid","routeSlug":"/openapi/documents/documentsgetbyid","metadata":{"seo":{"title":"Retrieve a document by id","description":"Retrieve a document by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentsGetById","name":"Retrieve a document by id","isWebhook":false,"pointer":"/paths/~1documents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a document by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a document by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the document to get.","required":true}],"pointer":"/paths/~1documents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.read"]}],"responseCodes":["200","404","429"],"pointer":"/documents/{id}","href":"documents/documentsgetbyid","openApiOperationId":"documentsGetById","summary":"Retrieve a document by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentResponse"}},"schemaId":"components/schemas/DocumentResponse"},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentResponse"}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentsgetbyid"}],"panels":[]}]},"httpPath":"/documents/{id}"},{"label":"Provide information about a transfer of a document to the target system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentsupdatetransfer","routeSlug":"/openapi/documents/documentsupdatetransfer","metadata":{"seo":{"title":"Provide information about a transfer of a document to the target system","description":"Update information about the transfer for the given document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentsUpdateTransfer","name":"Provide information about a transfer of a document to the target system","isWebhook":false,"pointer":"/paths/~1documents~1{id}~1transfer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provide information about a transfer of a document to the target system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update information about the transfer for the given document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of of the document to update.","required":true}],"pointer":"/paths/~1documents~1{id}~1transfer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateTransferRequest","exampleIds":["paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"]}},"schemaId":"components/schemas/DocumentsUpdateTransferRequest","exampleIds":["paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"],"pointer":"/paths/~1documents~1{id}~1transfer/post/requestBody","description":"Payload about the transfer"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/{id}/transfer","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateTransferRequest","exampleIds":["paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"]}},"responseCodes":["202","400","404","429"],"pointer":"/documents/{id}/transfer","href":"documents/documentsupdatetransfer","openApiOperationId":"documentsUpdateTransfer","summary":"Provide information about a transfer of a document to the target system"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/DocumentsUpdateTransferRequest","exampleIds":["paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateTransferRequest","exampleIds":["paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Document transfer infor accepted"},{"code":"400","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}~1transfer/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1transfer/post/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentsupdatetransfer"}],"panels":[]}]},"httpPath":"/documents/{id}/transfer"},{"label":"Provide information about the rejection of a document in the target system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentsupdatereject","routeSlug":"/openapi/documents/documentsupdatereject","metadata":{"seo":{"title":"Provide information about the rejection of a document in the target system","description":"Update information about the rejection for the given document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentsUpdateReject","name":"Provide information about the rejection of a document in the target system","isWebhook":false,"pointer":"/paths/~1documents~1{id}~1reject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provide information about the rejection of a document in the target system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update information about the rejection for the given document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of of the document to update.","required":true}],"pointer":"/paths/~1documents~1{id}~1reject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateRejectionRequest","exampleIds":["paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success"]}},"schemaId":"components/schemas/DocumentsUpdateRejectionRequest","exampleIds":["paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success"],"pointer":"/paths/~1documents~1{id}~1reject/post/requestBody","description":"Payload about the rejection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/{id}/reject","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateRejectionRequest","exampleIds":["paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success"]}},"responseCodes":["202","400","404","429"],"pointer":"/documents/{id}/reject","href":"documents/documentsupdatereject","openApiOperationId":"documentsUpdateReject","summary":"Provide information about the rejection of a document in the target system"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/DocumentsUpdateRejectionRequest","exampleIds":["paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateRejectionRequest","exampleIds":["paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Document rejection request accepted"},{"code":"400","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}~1reject/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1reject/post/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentsupdatereject"}],"panels":[]}]},"httpPath":"/documents/{id}/reject"},{"label":"Provide external data for a document with given id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentupdateexternaldata","routeSlug":"/openapi/documents/documentupdateexternaldata","metadata":{"seo":{"title":"Provide external data for a document with given id","description":"Update the external data for a document with given identifier. The external data are provided as a flat JSON object. The payload of this requests completley overrides the existing external data of a document. To remove the data, justsend empty JSON object {} in the payload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentUpdateExternalData","name":"Provide external data for a document with given id","isWebhook":false,"pointer":"/paths/~1documents~1{id}~1external-data/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provide external data for a document with given id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the external data for a document with given identifier. The external data are provided as a flat JSON object. The payload of this requests completley overrides the existing external data of a document. To remove the data, justsend empty JSON object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that the maximum lenght of an key is 50 characters. Any value with a longer key will be omitted. The maximum amount of key-value pairs is limited to 20."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the document to update.","required":true}],"pointer":"/paths/~1documents~1{id}~1external-data/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateExternalDataRequest"}},"schemaId":"components/schemas/DocumentsUpdateExternalDataRequest","pointer":"/paths/~1documents~1{id}~1external-data/post/requestBody","description":"Payload containing the external data."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/{id}/external-data","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateExternalDataRequest"}},"responseCodes":["202","400","404","429"],"pointer":"/documents/{id}/external-data","href":"documents/documentupdateexternaldata","openApiOperationId":"documentUpdateExternalData","summary":"Provide external data for a document with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/DocumentsUpdateExternalDataRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentsUpdateExternalDataRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"External data provided for the document accepted."},{"code":"400","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}~1external-data/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-data/post/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentupdateexternaldata"}],"panels":[]}]},"httpPath":"/documents/{id}/external-data"},{"label":"Provide an external identifier for a document with given id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentsupdateexternalid","routeSlug":"/openapi/documents/documentsupdateexternalid","metadata":{"seo":{"title":"Provide an external identifier for a document with given id","description":"Provide an external identifier for a document with given id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentsUpdateExternalId","name":"Provide an external identifier for a document with given id","isWebhook":false,"pointer":"/paths/~1documents~1{id}~1external-id/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provide an external identifier for a document with given id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provide an external identifier for a document with given id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the document to update.","required":true}],"pointer":"/paths/~1documents~1{id}~1external-id/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"components/schemas/DocumentsUpdateExternalIdRequest"}},"schemaId":"components/schemas/DocumentsUpdateExternalIdRequest","pointer":"/paths/~1documents~1{id}~1external-id/post/requestBody","description":"Update external id for a given document."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/{id}/external-id","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.write"]}],"requestBody":{"text/plain":{"schemaId":"components/schemas/DocumentsUpdateExternalIdRequest"}},"responseCodes":["202","400","404","429"],"pointer":"/documents/{id}/external-id","href":"documents/documentsupdateexternalid","openApiOperationId":"documentsUpdateExternalId","summary":"Provide an external identifier for a document with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/DocumentsUpdateExternalIdRequest","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"components/schemas/DocumentsUpdateExternalIdRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"External ID provided for the document accepted."},{"code":"400","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}~1external-id/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1external-id/post/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentsupdateexternalid"}],"panels":[]}]},"httpPath":"/documents/{id}/external-id"},{"label":"Provide a title for a document with given id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/documentsupdatetitle","routeSlug":"/openapi/documents/documentsupdatetitle","metadata":{"seo":{"title":"Provide a title for a document with given id","description":"Provide a title for a document with given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentsUpdateTitle","name":"Provide a title for a document with given id","isWebhook":false,"pointer":"/paths/~1documents~1{id}~1title/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provide a title for a document with given id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provide a title for a document with given id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the document to update.","required":true}],"pointer":"/paths/~1documents~1{id}~1title/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"components/schemas/DocumentsUpdateTitleRequest"}},"schemaId":"components/schemas/DocumentsUpdateTitleRequest","pointer":"/paths/~1documents~1{id}~1title/post/requestBody","description":"Title for a given document."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/{id}/title","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.write"]}],"requestBody":{"text/plain":{"schemaId":"components/schemas/DocumentsUpdateTitleRequest"}},"responseCodes":["202","400","404","429"],"pointer":"/documents/{id}/title","href":"documents/documentsupdatetitle","openApiOperationId":"documentsUpdateTitle","summary":"Provide a title for a document with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/DocumentsUpdateTitleRequest","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"components/schemas/DocumentsUpdateTitleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Document title provided for the document accepted."},{"code":"400","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}~1title/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1title/post/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documentsupdatetitle"}],"panels":[]}]},"httpPath":"/documents/{id}/title"},{"label":"Retrieve document states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents/retrievedocumentstates","routeSlug":"/openapi/documents/retrievedocumentstates","metadata":{"seo":{"title":"Retrieve document states","description":"Provides a list of states that the specified document has passed through. If the document is still being processed, the number of returned states should not be considered final. Subsequent calls to this endpoint may return additional states as the document continues to progress through the processing pipeline."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveDocumentStates","name":"Retrieve document states","isWebhook":false,"pointer":"/paths/~1documents~1{id}~1states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve document states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a list of states that the specified document has passed through. If the document is still being processed, the number of returned states should not be considered final. Subsequent calls to this endpoint may return additional states as the document continues to progress through the processing pipeline."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the document to get states of.","required":true}],"pointer":"/paths/~1documents~1{id}~1states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{id}/states","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.read"]}],"responseCodes":["200","404","429"],"pointer":"/documents/{id}/states","href":"documents/retrievedocumentstates","openApiOperationId":"retrieveDocumentStates","summary":"Retrieve document states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document states.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentStatesResponse"}},"schemaId":"components/schemas/DocumentStatesResponse"},{"code":"404","description":"Error occured while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1states/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1states/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1documents~1{id}~1states/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentStatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentStatesResponse"}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1states/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1documents~1{id}~1states/get/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/retrievedocumentstates"}],"panels":[]}]},"httpPath":"/documents/{id}/states"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for document management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/documents","summary":"Retrieve a list of documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/documentslist","deprecated":false},{"title":"/documents/process-file","summary":"Request processing of a file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/processfileintodocument","deprecated":false},{"title":"/documents/{id}","summary":"Retrieve a document by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/documentsgetbyid","deprecated":false},{"title":"/documents/{id}/transfer","summary":"Provide information about a transfer of a document to the target system","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/documentsupdatetransfer","deprecated":false},{"title":"/documents/{id}/reject","summary":"Provide information about the rejection of a document in the target system","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/documentsupdatereject","deprecated":false},{"title":"/documents/{id}/external-data","summary":"Provide external data for a document with given id","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/documentupdateexternaldata","deprecated":false},{"title":"/documents/{id}/external-id","summary":"Provide an external identifier for a document with given id","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/documentsupdateexternalid","deprecated":false},{"title":"/documents/{id}/title","summary":"Provide a title for a document with given id","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/documentsupdatetitle","deprecated":false},{"title":"/documents/{id}/states","summary":"Retrieve document states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/retrievedocumentstates","deprecated":false}]}]}]}]}},{"type":"group","label":"Cases","link":"/openapi/cases","routeSlug":"/openapi/cases","items":[{"label":"Request processing of a file batch into cases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cases/processfilebatchintocases","routeSlug":"/openapi/cases/processfilebatchintocases","metadata":{"seo":{"title":"Request processing of a file batch into cases","description":"Request processing of a batch of files that were previously uploaded.The fileIds in the request body represent the identifiers of the filesreturned by the upload endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processFileBatchIntoCases","name":"Request processing of a file batch into cases","isWebhook":false,"pointer":"/paths/~1cases~1process-file-batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request processing of a file batch into cases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request processing of a batch of files that were previously uploaded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body represent the identifiers of the files"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned by the upload endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an asynchronous operation. A successful response confirms that the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request has been accepted; the actual case creation is carried out in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background by AI Agents that analyze the file batch to determine which files"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"belong to which case and what role each file plays. Use the returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileBatchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to track the resulting cases via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /cases"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body is the identifier of the project in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which the cases will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields will be associated with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both the file batch and propagated to each case created from it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["cases.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessFileBatchRequest","exampleIds":["paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData"]}},"schemaId":"components/schemas/ProcessFileBatchRequest","exampleIds":["paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData"],"pointer":"/paths/~1cases~1process-file-batch/post/requestBody","description":"Payload for processing the given file batch"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cases/process-file-batch","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["cases.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessFileBatchRequest","exampleIds":["paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData"]}},"responseCodes":["202","400","404","422","429"],"pointer":"/cases/process-file-batch","href":"cases/processfilebatchintocases","openApiOperationId":"processFileBatchIntoCases","summary":"Request processing of a file batch into cases"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ProcessFileBatchRequest","exampleIds":["paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessFileBatchRequest","exampleIds":["paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"File batch processing request accepted. Cases will be created asynchronously.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessFileBatchAccepted"}},"schemaId":"components/schemas/ProcessFileBatchAccepted"},{"code":"400","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]},{"code":"404","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]},{"code":"422","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/isAPreProcessingProject"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1cases~1process-file-batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ProcessFileBatchAccepted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessFileBatchAccepted"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/processfilebatchintocases"}],"panels":[]}]},"httpPath":"/cases/process-file-batch"},{"label":"Create a case manually","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cases/createcase","routeSlug":"/openapi/cases/createcase","metadata":{"seo":{"title":"Create a case manually","description":"Manually create a case from a list of previously uploaded files. Each filein the request must be accompanied by a type indicating the role the fileplays in the case (e.g. main document, attachment)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCase","name":"Create a case manually","isWebhook":false,"pointer":"/paths/~1cases~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a case manually","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually create a case from a list of previously uploaded files. Each file"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the request must be accompanied by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the role the file"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plays in the case (e.g. main document, attachment)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the manual case creation path, intended for API clients that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"determine case composition directly, as opposed to the AI-driven case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation triggered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /cases/process-file-batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an asynchronous operation. A successful response confirms that the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request has been accepted and returns the identifier of the case being"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created. The case will be processed in the background."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body is the identifier of the project in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which the case will be created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["cases.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCaseRequest","exampleIds":["paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact","paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData"]}},"schemaId":"components/schemas/CreateCaseRequest","exampleIds":["paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact","paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData"],"pointer":"/paths/~1cases~1create/post/requestBody","description":"Payload for creating a case"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cases/create","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["cases.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCaseRequest","exampleIds":["paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact","paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData"]}},"responseCodes":["202","400","404","422","429"],"pointer":"/cases/create","href":"cases/createcase","openApiOperationId":"createCase","summary":"Create a case manually"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateCaseRequest","exampleIds":["paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact","paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCaseRequest","exampleIds":["paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact","paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic","paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Case creation request accepted. The case will be created asynchronously.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCaseAccepted"}},"schemaId":"components/schemas/CreateCaseAccepted"},{"code":"400","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]},{"code":"404","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]},{"code":"422","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/422/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/422/content/application~1json/examples/isAPreProcessingProject"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1cases~1create/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/CreateCaseAccepted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCaseAccepted"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/400/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/404/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/422/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1create/post/responses/422/content/application~1json/examples/notFound","paths/~1cases~1create/post/responses/422/content/application~1json/examples/badRequest","paths/~1cases~1create/post/responses/422/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1create/post/responses/422/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/createcase"}],"panels":[]}]},"httpPath":"/cases/create"},{"label":"Retrieve a list of cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cases/caseslist","routeSlug":"/openapi/cases/caseslist","metadata":{"seo":{"title":"Retrieve a list of cases","description":"Retrieve a list of cases."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"casesList","name":"Retrieve a list of cases","isWebhook":false,"pointer":"/paths/~1cases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of cases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of cases."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["cases.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectIds","in":"query","schemaId":"schema_5","description":"Used to retrieve cases belonging to specific projects only. Multiple project identifiers can be provided. By default, cases from all accessible projects are returned."},{"name":"offset","in":"query","schemaId":"schema_6","description":"A zero-based offset of the first item in the data collection to return."},{"name":"limit","in":"query","schemaId":"schema_7","description":"Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used."},{"name":"sort","in":"query","schemaId":"schema_8","description":"The field to sort reponse items by."},{"name":"state","in":"query","schemaId":"schema_10","description":"Used to retrieve cases that are in specific states only. Multiple states can be used for this filtering. By default, cases in all states are returned."},{"name":"fileBatchId","in":"query","schemaId":"schema_2","description":"File batch identifier to retrieve cases that were created from that file batch."}],"pointer":"/paths/~1cases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cases","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"projectIds","in":"query","required":false,"schemaId":"schema_5","style":"form","explode":false},{"name":"offset","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"schemaId":"schema_7"},{"name":"sort","in":"query","required":false,"schemaId":"schema_8"},{"name":"state","in":"query","required":false,"schemaId":"schema_10","style":"form","explode":true},{"name":"fileBatchId","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["cases.read"]}],"responseCodes":["200","400","429"],"pointer":"/cases","href":"cases/caseslist","openApiOperationId":"casesList","summary":"Retrieve a list of cases"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of cases","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CasesListResponse"}},"schemaId":"components/schemas/CasesListResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1cases/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/InvalidSortDefinition"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1cases/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/InvalidSortDefinition"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1cases/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CasesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CasesListResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1cases/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/InvalidSortDefinition"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases/get/responses/400/content/application~1json/examples/InvalidProjectId","paths/~1cases/get/responses/400/content/application~1json/examples/OffsetOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/LimitOutOfRange","paths/~1cases/get/responses/400/content/application~1json/examples/InvalidSortDefinition"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/caseslist"}],"panels":[]}]},"httpPath":"/cases"},{"label":"Retrieve a case by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cases/casesgetbyid","routeSlug":"/openapi/cases/casesgetbyid","metadata":{"seo":{"title":"Retrieve a case by id","description":"Retrieve a case by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"casesGetById","name":"Retrieve a case by id","isWebhook":false,"pointer":"/paths/~1cases~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a case by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a case by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["cases.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the case to get.","required":true,"example":"d43447fc-4e23-42e2-86cc-b35e16fa5e6f"}],"pointer":"/paths/~1cases~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cases/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"d43447fc-4e23-42e2-86cc-b35e16fa5e6f","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["cases.read"]}],"responseCodes":["200","404","429"],"pointer":"/cases/{id}","href":"cases/casesgetbyid","openApiOperationId":"casesGetById","summary":"Retrieve a case by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Case retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaseResponse"}},"schemaId":"components/schemas/CaseResponse"},{"code":"404","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/isAPreProcessingProject"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1cases~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaseResponse"}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/casesgetbyid"}],"panels":[]}]},"httpPath":"/cases/{id}"},{"label":"Provide information about a transfer of a case to the target system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cases/casesupdatetransfer","routeSlug":"/openapi/cases/casesupdatetransfer","metadata":{"seo":{"title":"Provide information about a transfer of a case to the target system","description":"Update information about the transfer for the given case."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"casesUpdateTransfer","name":"Provide information about a transfer of a case to the target system","isWebhook":false,"pointer":"/paths/~1cases~1{id}~1transfer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provide information about a transfer of a case to the target system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update information about the transfer for the given case."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["cases.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the case to update.","required":true}],"pointer":"/paths/~1cases~1{id}~1transfer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CasesUpdateTransferRequest","exampleIds":["paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"]}},"schemaId":"components/schemas/CasesUpdateTransferRequest","exampleIds":["paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"],"pointer":"/paths/~1cases~1{id}~1transfer/post/requestBody","description":"Payload about the transfer"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cases/{id}/transfer","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["cases.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CasesUpdateTransferRequest","exampleIds":["paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"]}},"responseCodes":["202","400","404","429"],"pointer":"/cases/{id}/transfer","href":"cases/casesupdatetransfer","openApiOperationId":"casesUpdateTransfer","summary":"Provide information about a transfer of a case to the target system"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CasesUpdateTransferRequest","exampleIds":["paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CasesUpdateTransferRequest","exampleIds":["paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success","paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Case transfer info accepted"},{"code":"400","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]},{"code":"404","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1cases~1{id}~1transfer/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/casesupdatetransfer"}],"panels":[]}]},"httpPath":"/cases/{id}/transfer"},{"label":"Download files of a case","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cases/casefilesdownload","routeSlug":"/openapi/cases/casefilesdownload","metadata":{"seo":{"title":"Download files of a case","description":"Download the files that are part of a case. The response format is determinedby the Accept header:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"caseFilesDownload","name":"Download files of a case","isWebhook":false,"pointer":"/paths/~1cases~1{id}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download files of a case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the files that are part of a case. The response format is determined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/mixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns all files as a multipart response, where each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"part contains the binary content of a file with its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. This allows the client to iterate over the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parts and attach each file individually to a workflow without any unzipping."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns all files packaged as a ZIP archive. Each file"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is stored under its original filename as provided during upload. Use this if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your HTTP client does not support multipart response parsing."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The files returned can be filtered by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag or by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using the query parameters below. If no filters are provided, all files of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case are returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["cases.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the case whose files should be downloaded.","required":true}],"pointer":"/paths/~1cases~1{id}~1files/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"mainFile","in":"query","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the main file of the case is returned. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only non-main files are returned. If omitted, all files are returned regardless of their main file flag."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_12","description":"Used to retrieve only files of specific types. Multiple types can be provided. If omitted, files of all types are returned."}],"pointer":"/paths/~1cases~1{id}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cases/{id}/files","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"mainFile","in":"query","required":false,"schemaId":"schema_11"},{"name":"type","in":"query","required":false,"schemaId":"schema_12","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["cases.read"]}],"responseCodes":["200","400","404","406","429"],"pointer":"/cases/{id}/files","href":"cases/casefilesdownload","openApiOperationId":"caseFilesDownload","summary":"Download files of a case"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Files of the case.","mediaType":"multipart/mixed","mediaTypes":["multipart/mixed","application/zip"],"mediaTypeContent":{"multipart/mixed":{"schemaId":"schema_13"},"application/zip":{"schemaId":"schema_14"}},"schemaId":"schema_13","headers":{"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses, suggests a filename for the downloaded archive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case-{id}-files.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","example":"attachment; filename=\"case-6040dc9680b782b365ea77d5-files.zip\""}}},"headerSchemaId":"schema_15"},{"code":"400","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/isAPreProcessingProject"]},{"code":"404","description":"Error occurred while processing request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/isAPreProcessingProject"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/isAPreProcessingProject"]},{"code":"406","description":"The requested response format specified in the Accept header is not supported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/406/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/406/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1cases~1{id}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["multipart/mixed","application/zip"],"mediaTypeContent":{"multipart/mixed":{"schemaId":"schema_13"},"application/zip":{"schemaId":"schema_14"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/isAPreProcessingProject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notFound","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/badRequest","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notAPreProcessingProject","paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/isAPreProcessingProject"]}}},{"code":"406","schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cases~1{id}~1files/get/responses/406/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/casefilesdownload"}],"panels":[]}]},"httpPath":"/cases/{id}/files"}],"content":{"contentType":"group","meta":{"name":"Cases"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cases","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for case management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cases/process-file-batch","summary":"Request processing of a file batch into cases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/processfilebatchintocases","deprecated":false},{"title":"/cases/create","summary":"Create a case manually","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/createcase","deprecated":false},{"title":"/cases","summary":"Retrieve a list of cases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/caseslist","deprecated":false},{"title":"/cases/{id}","summary":"Retrieve a case by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/casesgetbyid","deprecated":false},{"title":"/cases/{id}/transfer","summary":"Provide information about a transfer of a case to the target system","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/casesupdatetransfer","deprecated":false},{"title":"/cases/{id}/files","summary":"Download files of a case","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/casefilesdownload","deprecated":false}]}]}]}]}},{"type":"group","label":"Enrichment","link":"/openapi/enrichment","routeSlug":"/openapi/enrichment","items":[{"label":"Insert invoice including invoice lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertinvoice","routeSlug":"/openapi/enrichment/insertinvoice","metadata":{"seo":{"title":"Insert invoice including invoice lines","description":"Insert invoice including invoice lines"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertInvoice","name":"Insert invoice including invoice lines","isWebhook":false,"pointer":"/paths/~1enrichment~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert invoice including invoice lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/invoice"}},"schemaId":"components/schemas/invoice","pointer":"/paths/~1enrichment~1invoices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/invoices","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/invoice"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/invoices","href":"enrichment/insertinvoice","openApiOperationId":"insertInvoice","summary":"Insert invoice including invoice lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertinvoice"}],"panels":[]}]},"httpPath":"/enrichment/invoices"},{"label":"Partially update invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchinvoice","routeSlug":"/openapi/enrichment/patchinvoice","metadata":{"seo":{"title":"Partially update invoice","description":"Partially update invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInvoice","name":"Partially update invoice","isWebhook":false,"pointer":"/paths/~1enrichment~1invoices~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1invoices~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/invoice"}},"schemaId":"components/schemas/invoice","pointer":"/paths/~1enrichment~1invoices~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/invoices/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/invoice"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/invoices/{externalId}","href":"enrichment/patchinvoice","openApiOperationId":"patchInvoice","summary":"Partially update invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/invoice","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invoice"}},"schemaId":"components/schemas/invoice"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1invoices~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invoice"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchinvoice"}],"panels":[]}]},"httpPath":"/enrichment/invoices/{externalId}"},{"label":"Delete invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteinvoice","routeSlug":"/openapi/enrichment/deleteinvoice","metadata":{"seo":{"title":"Delete invoice","description":"Delete invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInvoice","name":"Delete invoice","isWebhook":false,"pointer":"/paths/~1enrichment~1invoices~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1invoices~1{externalId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lineNumber","in":"query","schemaId":"schema_2","description":"Line number of one of the line numbers inside the Invoice.\nOptional, omitting means the whole Invoice is deleted.\n"}],"pointer":"/paths/~1enrichment~1invoices~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/invoices/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"lineNumber","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/invoices/{externalId}","href":"enrichment/deleteinvoice","openApiOperationId":"deleteInvoice","summary":"Delete invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1invoices~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1invoices~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteinvoice"}],"panels":[]}]},"httpPath":"/enrichment/invoices/{externalId}"},{"label":"Insert company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertcompany","routeSlug":"/openapi/enrichment/insertcompany","metadata":{"seo":{"title":"Insert company","description":"Insert company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertCompany","name":"Insert company","isWebhook":false,"pointer":"/paths/~1enrichment~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company"}},"schemaId":"components/schemas/company","pointer":"/paths/~1enrichment~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/companies","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/companies","href":"enrichment/insertcompany","openApiOperationId":"insertCompany","summary":"Insert company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/company","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertcompany"}],"panels":[]}]},"httpPath":"/enrichment/companies"},{"label":"Partially update company","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchcompany","routeSlug":"/openapi/enrichment/patchcompany","metadata":{"seo":{"title":"Partially update company","description":"Partially update company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCompany","name":"Partially update company","isWebhook":false,"pointer":"/paths/~1enrichment~1companies~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1companies~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/company"}},"schemaId":"components/schemas/company","pointer":"/paths/~1enrichment~1companies~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/companies/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/company"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/companies/{externalId}","href":"enrichment/patchcompany","openApiOperationId":"patchCompany","summary":"Partially update company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/company","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/company"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company"}},"schemaId":"components/schemas/company"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1companies~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchcompany"}],"panels":[]}]},"httpPath":"/enrichment/companies/{externalId}"},{"label":"Delete company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletecompany","routeSlug":"/openapi/enrichment/deletecompany","metadata":{"seo":{"title":"Delete company","description":"Delete company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompany","name":"Delete company","isWebhook":false,"pointer":"/paths/~1enrichment~1companies~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1companies~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/companies/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/companies/{externalId}","href":"enrichment/deletecompany","openApiOperationId":"deleteCompany","summary":"Delete company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1companies~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1companies~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletecompany"}],"panels":[]}]},"httpPath":"/enrichment/companies/{externalId}"},{"label":"Insert supplier including related subsidiaries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertsupplier","routeSlug":"/openapi/enrichment/insertsupplier","metadata":{"seo":{"title":"Insert supplier including related subsidiaries","description":"Insert supplier including related subsidiaries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertSupplier","name":"Insert supplier including related subsidiaries","isWebhook":false,"pointer":"/paths/~1enrichment~1suppliers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert supplier including related subsidiaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/supplier"}},"schemaId":"components/schemas/supplier","pointer":"/paths/~1enrichment~1suppliers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/suppliers","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/supplier"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/suppliers","href":"enrichment/insertsupplier","openApiOperationId":"insertSupplier","summary":"Insert supplier including related subsidiaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/supplier","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/supplier"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1suppliers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertsupplier"}],"panels":[]}]},"httpPath":"/enrichment/suppliers"},{"label":"Partially update supplier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchsupplier","routeSlug":"/openapi/enrichment/patchsupplier","metadata":{"seo":{"title":"Partially update supplier","description":"Partially update supplier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSupplier","name":"Partially update supplier","isWebhook":false,"pointer":"/paths/~1enrichment~1suppliers~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update supplier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1suppliers~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/supplier"}},"schemaId":"components/schemas/supplier","pointer":"/paths/~1enrichment~1suppliers~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/suppliers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/supplier"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/suppliers/{externalId}","href":"enrichment/patchsupplier","openApiOperationId":"patchSupplier","summary":"Partially update supplier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/supplier","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/supplier"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/supplier"}},"schemaId":"components/schemas/supplier"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1suppliers~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/supplier","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/supplier"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchsupplier"}],"panels":[]}]},"httpPath":"/enrichment/suppliers/{externalId}"},{"label":"Delete supplier","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletesupplier","routeSlug":"/openapi/enrichment/deletesupplier","metadata":{"seo":{"title":"Delete supplier","description":"Delete supplier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSupplier","name":"Delete supplier","isWebhook":false,"pointer":"/paths/~1enrichment~1suppliers~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete supplier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1suppliers~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/suppliers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/suppliers/{externalId}","href":"enrichment/deletesupplier","openApiOperationId":"deleteSupplier","summary":"Delete supplier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1suppliers~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1suppliers~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletesupplier"}],"panels":[]}]},"httpPath":"/enrichment/suppliers/{externalId}"},{"label":"Insert purchase order including purchase order lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertpurchaseorder","routeSlug":"/openapi/enrichment/insertpurchaseorder","metadata":{"seo":{"title":"Insert purchase order including purchase order lines","description":"Insert purchase order including purchase order lines"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertPurchaseOrder","name":"Insert purchase order including purchase order lines","isWebhook":false,"pointer":"/paths/~1enrichment~1purchase-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert purchase order including purchase order lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/purchaseOrder"}},"schemaId":"components/schemas/purchaseOrder","pointer":"/paths/~1enrichment~1purchase-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/purchase-orders","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/purchaseOrder"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/purchase-orders","href":"enrichment/insertpurchaseorder","openApiOperationId":"insertPurchaseOrder","summary":"Insert purchase order including purchase order lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/purchaseOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/purchaseOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1purchase-orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertpurchaseorder"}],"panels":[]}]},"httpPath":"/enrichment/purchase-orders"},{"label":"Partially update purchase order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchpurchaseorder","routeSlug":"/openapi/enrichment/patchpurchaseorder","metadata":{"seo":{"title":"Partially update purchase order","description":"Partially update purchase order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPurchaseOrder","name":"Partially update purchase order","isWebhook":false,"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update purchase order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/purchaseOrder"}},"schemaId":"components/schemas/purchaseOrder","pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/purchase-orders/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/purchaseOrder"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/purchase-orders/{externalId}","href":"enrichment/patchpurchaseorder","openApiOperationId":"patchPurchaseOrder","summary":"Partially update purchase order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/purchaseOrder","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/purchaseOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/purchaseOrder"}},"schemaId":"components/schemas/purchaseOrder"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/purchaseOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/purchaseOrder"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchpurchaseorder"}],"panels":[]}]},"httpPath":"/enrichment/purchase-orders/{externalId}"},{"label":"Delete purchase Order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletepurchaseorder","routeSlug":"/openapi/enrichment/deletepurchaseorder","metadata":{"seo":{"title":"Delete purchase Order","description":"Delete purchase Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePurchaseOrder","name":"Delete purchase Order","isWebhook":false,"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete purchase Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lineNumber","in":"query","schemaId":"schema_2","description":"Line number of one of the line numbers inside the PO.\nOptional, omitting means the whole PO is deleted.\n"}],"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/purchase-orders/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"lineNumber","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/purchase-orders/{externalId}","href":"enrichment/deletepurchaseorder","openApiOperationId":"deletePurchaseOrder","summary":"Delete purchase Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletepurchaseorder"}],"panels":[]}]},"httpPath":"/enrichment/purchase-orders/{externalId}"},{"label":"Insert general ledger account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertglaccount","routeSlug":"/openapi/enrichment/insertglaccount","metadata":{"seo":{"title":"Insert general ledger account","description":"Insert general ledger account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertGLAccount","name":"Insert general ledger account","isWebhook":false,"pointer":"/paths/~1enrichment~1gl-accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert general ledger account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/glAccount"}},"schemaId":"components/schemas/glAccount","pointer":"/paths/~1enrichment~1gl-accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/gl-accounts","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/glAccount"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/gl-accounts","href":"enrichment/insertglaccount","openApiOperationId":"insertGLAccount","summary":"Insert general ledger account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/glAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/glAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1gl-accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertglaccount"}],"panels":[]}]},"httpPath":"/enrichment/gl-accounts"},{"label":"Partially update general ledger account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchglaccount","routeSlug":"/openapi/enrichment/patchglaccount","metadata":{"seo":{"title":"Partially update general ledger account","description":"Partially update general ledger account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGLAccount","name":"Partially update general ledger account","isWebhook":false,"pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update general ledger account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/glAccount"}},"schemaId":"components/schemas/glAccount","pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/gl-accounts/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/glAccount"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/gl-accounts/{externalId}","href":"enrichment/patchglaccount","openApiOperationId":"patchGLAccount","summary":"Partially update general ledger account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/glAccount","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/glAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/glAccount"}},"schemaId":"components/schemas/glAccount"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/glAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/glAccount"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchglaccount"}],"panels":[]}]},"httpPath":"/enrichment/gl-accounts/{externalId}"},{"label":"Delete general ledger account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteglaccount","routeSlug":"/openapi/enrichment/deleteglaccount","metadata":{"seo":{"title":"Delete general ledger account","description":"Delete general ledger account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGlAccount","name":"Delete general ledger account","isWebhook":false,"pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete general ledger account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/gl-accounts/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/gl-accounts/{externalId}","href":"enrichment/deleteglaccount","openApiOperationId":"deleteGlAccount","summary":"Delete general ledger account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteglaccount"}],"panels":[]}]},"httpPath":"/enrichment/gl-accounts/{externalId}"},{"label":"Insert cost center","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertcostcenter","routeSlug":"/openapi/enrichment/insertcostcenter","metadata":{"seo":{"title":"Insert cost center","description":"Insert cost center"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertCostCenter","name":"Insert cost center","isWebhook":false,"pointer":"/paths/~1enrichment~1cost-centers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert cost center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/costCenter"}},"schemaId":"components/schemas/costCenter","pointer":"/paths/~1enrichment~1cost-centers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/cost-centers","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/costCenter"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/cost-centers","href":"enrichment/insertcostcenter","openApiOperationId":"insertCostCenter","summary":"Insert cost center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/costCenter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/costCenter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1cost-centers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertcostcenter"}],"panels":[]}]},"httpPath":"/enrichment/cost-centers"},{"label":"Partially update cost center","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchcostcenter","routeSlug":"/openapi/enrichment/patchcostcenter","metadata":{"seo":{"title":"Partially update cost center","description":"Partially update cost center"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCostCenter","name":"Partially update cost center","isWebhook":false,"pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update cost center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/costCenter"}},"schemaId":"components/schemas/costCenter","pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/cost-centers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/costCenter"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/cost-centers/{externalId}","href":"enrichment/patchcostcenter","openApiOperationId":"patchCostCenter","summary":"Partially update cost center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/costCenter","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/costCenter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/costCenter"}},"schemaId":"components/schemas/costCenter"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/costCenter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/costCenter"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchcostcenter"}],"panels":[]}]},"httpPath":"/enrichment/cost-centers/{externalId}"},{"label":"Delete cost Center","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletecostcenter","routeSlug":"/openapi/enrichment/deletecostcenter","metadata":{"seo":{"title":"Delete cost Center","description":"Delete cost Center"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCostCenter","name":"Delete cost Center","isWebhook":false,"pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete cost Center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/cost-centers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/cost-centers/{externalId}","href":"enrichment/deletecostcenter","openApiOperationId":"deleteCostCenter","summary":"Delete cost Center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1cost-centers~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1cost-centers~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletecostcenter"}],"panels":[]}]},"httpPath":"/enrichment/cost-centers/{externalId}"},{"label":"Insert approver","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertapprover","routeSlug":"/openapi/enrichment/insertapprover","metadata":{"seo":{"title":"Insert approver","description":"Insert approver"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertApprover","name":"Insert approver","isWebhook":false,"pointer":"/paths/~1enrichment~1approvers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert approver","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/approver"}},"schemaId":"components/schemas/approver","pointer":"/paths/~1enrichment~1approvers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/approvers","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/approver"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/approvers","href":"enrichment/insertapprover","openApiOperationId":"insertApprover","summary":"Insert approver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/approver","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/approver"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1approvers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertapprover"}],"panels":[]}]},"httpPath":"/enrichment/approvers"},{"label":"Partially update approver","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchapprover","routeSlug":"/openapi/enrichment/patchapprover","metadata":{"seo":{"title":"Partially update approver","description":"Partially update approver"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApprover","name":"Partially update approver","isWebhook":false,"pointer":"/paths/~1enrichment~1approvers~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update approver","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1approvers~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/approver"}},"schemaId":"components/schemas/approver","pointer":"/paths/~1enrichment~1approvers~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/approvers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/approver"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/approvers/{externalId}","href":"enrichment/patchapprover","openApiOperationId":"patchApprover","summary":"Partially update approver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/approver","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/approver"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/approver"}},"schemaId":"components/schemas/approver"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1approvers~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/approver","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/approver"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchapprover"}],"panels":[]}]},"httpPath":"/enrichment/approvers/{externalId}"},{"label":"Delete approver","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteapprover","routeSlug":"/openapi/enrichment/deleteapprover","metadata":{"seo":{"title":"Delete approver","description":"Delete approver"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApprover","name":"Delete approver","isWebhook":false,"pointer":"/paths/~1enrichment~1approvers~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete approver","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1approvers~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/approvers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/approvers/{externalId}","href":"enrichment/deleteapprover","openApiOperationId":"deleteApprover","summary":"Delete approver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1approvers~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1approvers~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteapprover"}],"panels":[]}]},"httpPath":"/enrichment/approvers/{externalId}"},{"label":"Insert customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertcustomer","routeSlug":"/openapi/enrichment/insertcustomer","metadata":{"seo":{"title":"Insert customer","description":"Insert customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertCustomer","name":"Insert customer","isWebhook":false,"pointer":"/paths/~1enrichment~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/customer"}},"schemaId":"components/schemas/customer","pointer":"/paths/~1enrichment~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/customers","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/customer"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/customers","href":"enrichment/insertcustomer","openApiOperationId":"insertCustomer","summary":"Insert customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/customer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/customer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertcustomer"}],"panels":[]}]},"httpPath":"/enrichment/customers"},{"label":"Partially update customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchcustomer","routeSlug":"/openapi/enrichment/patchcustomer","metadata":{"seo":{"title":"Partially update customer","description":"Partially update customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCustomer","name":"Partially update customer","isWebhook":false,"pointer":"/paths/~1enrichment~1customers~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1customers~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/customer"}},"schemaId":"components/schemas/customer","pointer":"/paths/~1enrichment~1customers~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/customers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/customer"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/customers/{externalId}","href":"enrichment/patchcustomer","openApiOperationId":"patchCustomer","summary":"Partially update customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/customer","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/customer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}},"schemaId":"components/schemas/customer"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1customers~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchcustomer"}],"panels":[]}]},"httpPath":"/enrichment/customers/{externalId}"},{"label":"Delete customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletecustomer","routeSlug":"/openapi/enrichment/deletecustomer","metadata":{"seo":{"title":"Delete customer","description":"Delete customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomer","name":"Delete customer","isWebhook":false,"pointer":"/paths/~1enrichment~1customers~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1customers~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/customers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/customers/{externalId}","href":"enrichment/deletecustomer","openApiOperationId":"deleteCustomer","summary":"Delete customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1customers~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customers~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletecustomer"}],"panels":[]}]},"httpPath":"/enrichment/customers/{externalId}"},{"label":"Insert data row to lookup table","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertlookuptablerow","routeSlug":"/openapi/enrichment/insertlookuptablerow","metadata":{"seo":{"title":"Insert data row to lookup table","description":"Insert data row to lookup table"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertLookupTableRow","name":"Insert data row to lookup table","isWebhook":false,"pointer":"/paths/~1enrichment~1lookup-tables~1{type}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert data row to lookup table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_2","description":"type of data being sent","required":true}],"pointer":"/paths/~1enrichment~1lookup-tables~1{type}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/lookup-table-row"}},"schemaId":"components/schemas/lookup-table-row","pointer":"/paths/~1enrichment~1lookup-tables~1{type}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/lookup-tables/{type}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"type","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/lookup-table-row"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/lookup-tables/{type}","href":"enrichment/insertlookuptablerow","openApiOperationId":"insertLookupTableRow","summary":"Insert data row to lookup table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/lookup-table-row","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/lookup-table-row"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1lookup-tables~1{type}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertlookuptablerow"}],"panels":[]}]},"httpPath":"/enrichment/lookup-tables/{type}"},{"label":"Partially update data row in lookup table","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchlookuptablerow","routeSlug":"/openapi/enrichment/patchlookuptablerow","metadata":{"seo":{"title":"Partially update data row in lookup table","description":"Partially update data row in lookup table"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchLookupTableRow","name":"Partially update data row in lookup table","isWebhook":false,"pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update data row in lookup table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_2","description":"type of data being updated","required":true},{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/lookup-table-row"}},"schemaId":"components/schemas/lookup-table-row","pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/lookup-tables/{type}/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"type","in":"path","required":true,"schemaId":"schema_2"},{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/lookup-table-row"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/lookup-tables/{type}/{externalId}","href":"enrichment/patchlookuptablerow","openApiOperationId":"patchLookupTableRow","summary":"Partially update data row in lookup table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/lookup-table-row","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/lookup-table-row"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lookup-table-row"}},"schemaId":"components/schemas/lookup-table-row"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/lookup-table-row","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lookup-table-row"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchlookuptablerow"}],"panels":[]}]},"httpPath":"/enrichment/lookup-tables/{type}/{externalId}"},{"label":"Delete data row in lookup table","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletelookuptablerow","routeSlug":"/openapi/enrichment/deletelookuptablerow","metadata":{"seo":{"title":"Delete data row in lookup table","description":"Delete data row in lookup table"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLookupTableRow","name":"Delete data row in lookup table","isWebhook":false,"pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete data row in lookup table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_2","description":"type of data from which we should delete the row","required":true},{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/lookup-tables/{type}/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"type","in":"path","required":true,"schemaId":"schema_2"},{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/lookup-tables/{type}/{externalId}","href":"enrichment/deletelookuptablerow","openApiOperationId":"deleteLookupTableRow","summary":"Delete data row in lookup table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletelookuptablerow"}],"panels":[]}]},"httpPath":"/enrichment/lookup-tables/{type}/{externalId}"},{"label":"Insert contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertcontract","routeSlug":"/openapi/enrichment/insertcontract","metadata":{"seo":{"title":"Insert contract","description":"Insert contract"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertContract","name":"Insert contract","isWebhook":false,"pointer":"/paths/~1enrichment~1contracts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/contract"}},"schemaId":"components/schemas/contract","pointer":"/paths/~1enrichment~1contracts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/contracts","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/contract"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/contracts","href":"enrichment/insertcontract","openApiOperationId":"insertContract","summary":"Insert contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/contract","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/contract"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1contracts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertcontract"}],"panels":[]}]},"httpPath":"/enrichment/contracts"},{"label":"Partially update contract","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchcontract","routeSlug":"/openapi/enrichment/patchcontract","metadata":{"seo":{"title":"Partially update contract","description":"Partially update contract"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContract","name":"Partially update contract","isWebhook":false,"pointer":"/paths/~1enrichment~1contracts~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1contracts~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/contract"}},"schemaId":"components/schemas/contract","pointer":"/paths/~1enrichment~1contracts~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/contracts/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/contract"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/contracts/{externalId}","href":"enrichment/patchcontract","openApiOperationId":"patchContract","summary":"Partially update contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/contract","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/contract"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contract"}},"schemaId":"components/schemas/contract"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1contracts~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/contract","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contract"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchcontract"}],"panels":[]}]},"httpPath":"/enrichment/contracts/{externalId}"},{"label":"Delete contract","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletecontract","routeSlug":"/openapi/enrichment/deletecontract","metadata":{"seo":{"title":"Delete contract","description":"Delete contract"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContract","name":"Delete contract","isWebhook":false,"pointer":"/paths/~1enrichment~1contracts~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1contracts~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/contracts/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/contracts/{externalId}","href":"enrichment/deletecontract","openApiOperationId":"deleteContract","summary":"Delete contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1contracts~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1contracts~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletecontract"}],"panels":[]}]},"httpPath":"/enrichment/contracts/{externalId}"},{"label":"Insert sales order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertsalesorder","routeSlug":"/openapi/enrichment/insertsalesorder","metadata":{"seo":{"title":"Insert sales order","description":"Insert sales order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertSalesOrder","name":"Insert sales order","isWebhook":false,"pointer":"/paths/~1enrichment~1sales-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert sales order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/salesOrder"}},"schemaId":"components/schemas/salesOrder","pointer":"/paths/~1enrichment~1sales-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/sales-orders","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/salesOrder"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/sales-orders","href":"enrichment/insertsalesorder","openApiOperationId":"insertSalesOrder","summary":"Insert sales order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/salesOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/salesOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1sales-orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertsalesorder"}],"panels":[]}]},"httpPath":"/enrichment/sales-orders"},{"label":"Partially update sales order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchsalesorder","routeSlug":"/openapi/enrichment/patchsalesorder","metadata":{"seo":{"title":"Partially update sales order","description":"Partially update sales order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSalesOrder","name":"Partially update sales order","isWebhook":false,"pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update sales order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/salesOrder"}},"schemaId":"components/schemas/salesOrder","pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/sales-orders/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/salesOrder"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/sales-orders/{externalId}","href":"enrichment/patchsalesorder","openApiOperationId":"patchSalesOrder","summary":"Partially update sales order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/salesOrder","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/salesOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/salesOrder"}},"schemaId":"components/schemas/salesOrder"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/salesOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/salesOrder"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchsalesorder"}],"panels":[]}]},"httpPath":"/enrichment/sales-orders/{externalId}"},{"label":"Delete sales order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletesalesorder","routeSlug":"/openapi/enrichment/deletesalesorder","metadata":{"seo":{"title":"Delete sales order","description":"Delete sales order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSalesOrder","name":"Delete sales order","isWebhook":false,"pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete sales order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/sales-orders/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/sales-orders/{externalId}","href":"enrichment/deletesalesorder","openApiOperationId":"deleteSalesOrder","summary":"Delete sales order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1sales-orders~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1sales-orders~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletesalesorder"}],"panels":[]}]},"httpPath":"/enrichment/sales-orders/{externalId}"},{"label":"Insert product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertproduct","routeSlug":"/openapi/enrichment/insertproduct","metadata":{"seo":{"title":"Insert product","description":"Insert product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertProduct","name":"Insert product","isWebhook":false,"pointer":"/paths/~1enrichment~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/product"}},"schemaId":"components/schemas/product","pointer":"/paths/~1enrichment~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/products","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/product"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/products","href":"enrichment/insertproduct","openApiOperationId":"insertProduct","summary":"Insert product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/product","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/product"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertproduct"}],"panels":[]}]},"httpPath":"/enrichment/products"},{"label":"Partially update product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchproduct","routeSlug":"/openapi/enrichment/patchproduct","metadata":{"seo":{"title":"Partially update product","description":"Partially update product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProduct","name":"Partially update product","isWebhook":false,"pointer":"/paths/~1enrichment~1products~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1products~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/product"}},"schemaId":"components/schemas/product","pointer":"/paths/~1enrichment~1products~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/products/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/product"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/products/{externalId}","href":"enrichment/patchproduct","openApiOperationId":"patchProduct","summary":"Partially update product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/product","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/product"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/product"}},"schemaId":"components/schemas/product"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1products~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/product"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchproduct"}],"panels":[]}]},"httpPath":"/enrichment/products/{externalId}"},{"label":"Delete product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteproduct","routeSlug":"/openapi/enrichment/deleteproduct","metadata":{"seo":{"title":"Delete product","description":"Delete product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProduct","name":"Delete product","isWebhook":false,"pointer":"/paths/~1enrichment~1products~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1products~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/products/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/products/{externalId}","href":"enrichment/deleteproduct","openApiOperationId":"deleteProduct","summary":"Delete product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1products~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1products~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteproduct"}],"panels":[]}]},"httpPath":"/enrichment/products/{externalId}"},{"label":"Insert customer product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertcustomerproduct","routeSlug":"/openapi/enrichment/insertcustomerproduct","metadata":{"seo":{"title":"Insert customer product","description":"Insert customer product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertCustomerProduct","name":"Insert customer product","isWebhook":false,"pointer":"/paths/~1enrichment~1customer-products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert customer product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/customerProduct"}},"schemaId":"components/schemas/customerProduct","pointer":"/paths/~1enrichment~1customer-products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/customer-products","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/customerProduct"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/customer-products","href":"enrichment/insertcustomerproduct","openApiOperationId":"insertCustomerProduct","summary":"Insert customer product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/customerProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/customerProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1customer-products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertcustomerproduct"}],"panels":[]}]},"httpPath":"/enrichment/customer-products"},{"label":"Partially update customer product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchcustomerproduct","routeSlug":"/openapi/enrichment/patchcustomerproduct","metadata":{"seo":{"title":"Partially update customer product","description":"Partially update customer product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCustomerProduct","name":"Partially update customer product","isWebhook":false,"pointer":"/paths/~1enrichment~1customer-products~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update customer product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1customer-products~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/customerProduct"}},"schemaId":"components/schemas/customerProduct","pointer":"/paths/~1enrichment~1customer-products~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/customer-products/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/customerProduct"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/customer-products/{externalId}","href":"enrichment/patchcustomerproduct","openApiOperationId":"patchCustomerProduct","summary":"Partially update customer product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/customerProduct","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/customerProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customerProduct"}},"schemaId":"components/schemas/customerProduct"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1customer-products~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/customerProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customerProduct"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchcustomerproduct"}],"panels":[]}]},"httpPath":"/enrichment/customer-products/{externalId}"},{"label":"Delete customer product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletecustomerproduct","routeSlug":"/openapi/enrichment/deletecustomerproduct","metadata":{"seo":{"title":"Delete customer product","description":"Delete customer product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerProduct","name":"Delete customer product","isWebhook":false,"pointer":"/paths/~1enrichment~1customer-products~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete customer product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1customer-products~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/customer-products/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/customer-products/{externalId}","href":"enrichment/deletecustomerproduct","openApiOperationId":"deleteCustomerProduct","summary":"Delete customer product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1customer-products~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1customer-products~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletecustomerproduct"}],"panels":[]}]},"httpPath":"/enrichment/customer-products/{externalId}"},{"label":"Insert address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertaddress","routeSlug":"/openapi/enrichment/insertaddress","metadata":{"seo":{"title":"Insert address","description":"Insert address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertAddress","name":"Insert address","isWebhook":false,"pointer":"/paths/~1enrichment~1addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/address"}},"schemaId":"components/schemas/address","pointer":"/paths/~1enrichment~1addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/addresses","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/address"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/addresses","href":"enrichment/insertaddress","openApiOperationId":"insertAddress","summary":"Insert address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/address","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/address"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1addresses/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertaddress"}],"panels":[]}]},"httpPath":"/enrichment/addresses"},{"label":"Partially update address","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchaddress","routeSlug":"/openapi/enrichment/patchaddress","metadata":{"seo":{"title":"Partially update address","description":"Partially update address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAddress","name":"Partially update address","isWebhook":false,"pointer":"/paths/~1enrichment~1addresses~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1addresses~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/address"}},"schemaId":"components/schemas/address","pointer":"/paths/~1enrichment~1addresses~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/addresses/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/address"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/addresses/{externalId}","href":"enrichment/patchaddress","openApiOperationId":"patchAddress","summary":"Partially update address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/address","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/address"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/address"}},"schemaId":"components/schemas/address"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1addresses~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/address","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/address"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchaddress"}],"panels":[]}]},"httpPath":"/enrichment/addresses/{externalId}"},{"label":"Delete address","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteaddress","routeSlug":"/openapi/enrichment/deleteaddress","metadata":{"seo":{"title":"Delete address","description":"Delete address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAddress","name":"Delete address","isWebhook":false,"pointer":"/paths/~1enrichment~1addresses~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1addresses~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/addresses/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/addresses/{externalId}","href":"enrichment/deleteaddress","openApiOperationId":"deleteAddress","summary":"Delete address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1addresses~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1addresses~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteaddress"}],"panels":[]}]},"httpPath":"/enrichment/addresses/{externalId}"},{"label":"Insert quotes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertquotes","routeSlug":"/openapi/enrichment/insertquotes","metadata":{"seo":{"title":"Insert quotes","description":"Insert quotes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertQuotes","name":"Insert quotes","isWebhook":false,"pointer":"/paths/~1enrichment~1quotes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert quotes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote","pointer":"/paths/~1enrichment~1quotes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/quotes","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/quote"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/quotes","href":"enrichment/insertquotes","openApiOperationId":"insertQuotes","summary":"Insert quotes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/quote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/quote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1quotes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertquotes"}],"panels":[]}]},"httpPath":"/enrichment/quotes"},{"label":"Partially update quote","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchquotes","routeSlug":"/openapi/enrichment/patchquotes","metadata":{"seo":{"title":"Partially update quote","description":"Partially update quote"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchQuotes","name":"Partially update quote","isWebhook":false,"pointer":"/paths/~1enrichment~1quotes~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1quotes~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote","pointer":"/paths/~1enrichment~1quotes~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/quotes/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/quote"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/quotes/{externalId}","href":"enrichment/patchquotes","openApiOperationId":"patchQuotes","summary":"Partially update quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/quote","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/quote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1quotes~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchquotes"}],"panels":[]}]},"httpPath":"/enrichment/quotes/{externalId}"},{"label":"Delete quote","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletequotes","routeSlug":"/openapi/enrichment/deletequotes","metadata":{"seo":{"title":"Delete quote","description":"Delete quote"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteQuotes","name":"Delete quote","isWebhook":false,"pointer":"/paths/~1enrichment~1quotes~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1quotes~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/quotes/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/quotes/{externalId}","href":"enrichment/deletequotes","openApiOperationId":"deleteQuotes","summary":"Delete quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1quotes~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1quotes~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletequotes"}],"panels":[]}]},"httpPath":"/enrichment/quotes/{externalId}"},{"label":"Insert Goods Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertgoodsreceipts","routeSlug":"/openapi/enrichment/insertgoodsreceipts","metadata":{"seo":{"title":"Insert Goods Receipt","description":"Insert Goods Receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertGoodsReceipts","name":"Insert Goods Receipt","isWebhook":false,"pointer":"/paths/~1enrichment~1goods-receipts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert Goods Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goodsReceipt"}},"schemaId":"components/schemas/goodsReceipt","pointer":"/paths/~1enrichment~1goods-receipts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/goods-receipts","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/goodsReceipt"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/goods-receipts","href":"enrichment/insertgoodsreceipts","openApiOperationId":"insertGoodsReceipts","summary":"Insert Goods Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/goodsReceipt","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goodsReceipt"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1goods-receipts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertgoodsreceipts"}],"panels":[]}]},"httpPath":"/enrichment/goods-receipts"},{"label":"Partially update Goods Receipt","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchgoodsreceipt","routeSlug":"/openapi/enrichment/patchgoodsreceipt","metadata":{"seo":{"title":"Partially update Goods Receipt","description":"Partially update Goods Receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGoodsReceipt","name":"Partially update Goods Receipt","isWebhook":false,"pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update Goods Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/goodsReceipt"}},"schemaId":"components/schemas/goodsReceipt","pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/goods-receipts/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/goodsReceipt"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/goods-receipts/{externalId}","href":"enrichment/patchgoodsreceipt","openApiOperationId":"patchGoodsReceipt","summary":"Partially update Goods Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/goodsReceipt","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/goodsReceipt"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goodsReceipt"}},"schemaId":"components/schemas/goodsReceipt"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/goodsReceipt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goodsReceipt"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchgoodsreceipt"}],"panels":[]}]},"httpPath":"/enrichment/goods-receipts/{externalId}"},{"label":"Delete Goods Receipt","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deletegoodsreceipt","routeSlug":"/openapi/enrichment/deletegoodsreceipt","metadata":{"seo":{"title":"Delete Goods Receipt","description":"Delete Goods Receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGoodsReceipt","name":"Delete Goods Receipt","isWebhook":false,"pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Goods Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/goods-receipts/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/goods-receipts/{externalId}","href":"enrichment/deletegoodsreceipt","openApiOperationId":"deleteGoodsReceipt","summary":"Delete Goods Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deletegoodsreceipt"}],"panels":[]}]},"httpPath":"/enrichment/goods-receipts/{externalId}"},{"label":"Insert Profit Center","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertprofitcenter","routeSlug":"/openapi/enrichment/insertprofitcenter","metadata":{"seo":{"title":"Insert Profit Center","description":"Insert Profit Center"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertProfitCenter","name":"Insert Profit Center","isWebhook":false,"pointer":"/paths/~1enrichment~1profit-centers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert Profit Center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/profitCenter"}},"schemaId":"components/schemas/profitCenter","pointer":"/paths/~1enrichment~1profit-centers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/profit-centers","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/profitCenter"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/profit-centers","href":"enrichment/insertprofitcenter","openApiOperationId":"insertProfitCenter","summary":"Insert Profit Center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/profitCenter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/profitCenter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1profit-centers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertprofitcenter"}],"panels":[]}]},"httpPath":"/enrichment/profit-centers"},{"label":"Partially update Profit Center","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchprofitcenter","routeSlug":"/openapi/enrichment/patchprofitcenter","metadata":{"seo":{"title":"Partially update Profit Center","description":"Partially update Profit Center"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProfitCenter","name":"Partially update Profit Center","isWebhook":false,"pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update Profit Center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/profitCenter"}},"schemaId":"components/schemas/profitCenter","pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/profit-centers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/profitCenter"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/profit-centers/{externalId}","href":"enrichment/patchprofitcenter","openApiOperationId":"patchProfitCenter","summary":"Partially update Profit Center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/profitCenter","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/profitCenter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/profitCenter"}},"schemaId":"components/schemas/profitCenter"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/profitCenter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/profitCenter"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchprofitcenter"}],"panels":[]}]},"httpPath":"/enrichment/profit-centers/{externalId}"},{"label":"Delete Profit Center","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteprofitcenter","routeSlug":"/openapi/enrichment/deleteprofitcenter","metadata":{"seo":{"title":"Delete Profit Center","description":"Delete Profit Center"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProfitCenter","name":"Delete Profit Center","isWebhook":false,"pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Profit Center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/profit-centers/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/profit-centers/{externalId}","href":"enrichment/deleteprofitcenter","openApiOperationId":"deleteProfitCenter","summary":"Delete Profit Center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1profit-centers~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1profit-centers~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteprofitcenter"}],"panels":[]}]},"httpPath":"/enrichment/profit-centers/{externalId}"},{"label":"Insert Internal Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertinternalorder","routeSlug":"/openapi/enrichment/insertinternalorder","metadata":{"seo":{"title":"Insert Internal Order","description":"Insert Internal Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertInternalOrder","name":"Insert Internal Order","isWebhook":false,"pointer":"/paths/~1enrichment~1internal-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert Internal Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/internalOrder"}},"schemaId":"components/schemas/internalOrder","pointer":"/paths/~1enrichment~1internal-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/internal-orders","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/internalOrder"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/internal-orders","href":"enrichment/insertinternalorder","openApiOperationId":"insertInternalOrder","summary":"Insert Internal Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/internalOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/internalOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1internal-orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertinternalorder"}],"panels":[]}]},"httpPath":"/enrichment/internal-orders"},{"label":"Partially update Internal Order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchinternalorder","routeSlug":"/openapi/enrichment/patchinternalorder","metadata":{"seo":{"title":"Partially update Internal Order","description":"Partially update Internal Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInternalOrder","name":"Partially update Internal Order","isWebhook":false,"pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update Internal Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/internalOrder"}},"schemaId":"components/schemas/internalOrder","pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/internal-orders/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/internalOrder"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/internal-orders/{externalId}","href":"enrichment/patchinternalorder","openApiOperationId":"patchInternalOrder","summary":"Partially update Internal Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/internalOrder","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/internalOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internalOrder"}},"schemaId":"components/schemas/internalOrder"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/internalOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internalOrder"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchinternalorder"}],"panels":[]}]},"httpPath":"/enrichment/internal-orders/{externalId}"},{"label":"Delete Internal Order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteinternalorder","routeSlug":"/openapi/enrichment/deleteinternalorder","metadata":{"seo":{"title":"Delete Internal Order","description":"Delete Internal Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInternalOrder","name":"Delete Internal Order","isWebhook":false,"pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Internal Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/internal-orders/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/internal-orders/{externalId}","href":"enrichment/deleteinternalorder","openApiOperationId":"deleteInternalOrder","summary":"Delete Internal Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1internal-orders~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1internal-orders~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteinternalorder"}],"panels":[]}]},"httpPath":"/enrichment/internal-orders/{externalId}"},{"label":"Insert Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/insertproject","routeSlug":"/openapi/enrichment/insertproject","metadata":{"seo":{"title":"Insert Project","description":"Insert Project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"insertProject","name":"Insert Project","isWebhook":false,"pointer":"/paths/~1enrichment~1projects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/project"}},"schemaId":"components/schemas/project","pointer":"/paths/~1enrichment~1projects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment/projects","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/project"}},"responseCodes":["200","422","429"],"pointer":"/enrichment/projects","href":"enrichment/insertproject","openApiOperationId":"insertProject","summary":"Insert Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/project","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/project"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully inserted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1projects/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/insertproject"}],"panels":[]}]},"httpPath":"/enrichment/projects"},{"label":"Partially update Project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/patchproject","routeSlug":"/openapi/enrichment/patchproject","metadata":{"seo":{"title":"Partially update Project","description":"Partially update Project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProject","name":"Partially update Project","isWebhook":false,"pointer":"/paths/~1enrichment~1projects~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1projects~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/project"}},"schemaId":"components/schemas/project","pointer":"/paths/~1enrichment~1projects~1{externalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enrichment/projects/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.write"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/project"}},"responseCodes":["200","400","404","415","429"],"pointer":"/enrichment/projects/{externalId}","href":"enrichment/patchproject","openApiOperationId":"patchProject","summary":"Partially update Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/project","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/project"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/project"}},"schemaId":"components/schemas/project"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/patch/responses/404/content/application~1json/example"]},{"code":"415","description":"Unsupported media type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1projects~1{externalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/project","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/project"}}},{"code":"400","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"415","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/patchproject"}],"panels":[]}]},"httpPath":"/enrichment/projects/{externalId}"},{"label":"Delete Project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment/deleteproject","routeSlug":"/openapi/enrichment/deleteproject","metadata":{"seo":{"title":"Delete Project","description":"Delete Project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProject","name":"Delete Project","isWebhook":false,"pointer":"/paths/~1enrichment~1projects~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment.delete"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1enrichment~1projects~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment/projects/{externalId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment.delete"]}],"responseCodes":["204","404","429"],"pointer":"/enrichment/projects/{externalId}","href":"enrichment/deleteproject","openApiOperationId":"deleteProject","summary":"Delete Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted"},{"code":"404","description":"Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/delete/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment~1projects~1{externalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem","exampleIds":["paths/~1enrichment~1projects~1{externalId}/delete/responses/404/content/application~1json/example"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment/deleteproject"}],"panels":[]}]},"httpPath":"/enrichment/projects/{externalId}"}],"content":{"contentType":"group","meta":{"name":"Enrichment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrichment","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for data enrichment"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enrichment/invoices","summary":"Insert invoice including invoice lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertinvoice","deprecated":false},{"title":"/enrichment/invoices/{externalId}","summary":"Partially update invoice","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchinvoice","deprecated":false},{"title":"/enrichment/invoices/{externalId}","summary":"Delete invoice","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteinvoice","deprecated":false},{"title":"/enrichment/companies","summary":"Insert company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertcompany","deprecated":false},{"title":"/enrichment/companies/{externalId}","summary":"Partially update company","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchcompany","deprecated":false},{"title":"/enrichment/companies/{externalId}","summary":"Delete company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletecompany","deprecated":false},{"title":"/enrichment/suppliers","summary":"Insert supplier including related subsidiaries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertsupplier","deprecated":false},{"title":"/enrichment/suppliers/{externalId}","summary":"Partially update supplier","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchsupplier","deprecated":false},{"title":"/enrichment/suppliers/{externalId}","summary":"Delete supplier","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletesupplier","deprecated":false},{"title":"/enrichment/purchase-orders","summary":"Insert purchase order including purchase order lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertpurchaseorder","deprecated":false},{"title":"/enrichment/purchase-orders/{externalId}","summary":"Partially update purchase order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchpurchaseorder","deprecated":false},{"title":"/enrichment/purchase-orders/{externalId}","summary":"Delete purchase Order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletepurchaseorder","deprecated":false},{"title":"/enrichment/gl-accounts","summary":"Insert general ledger account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertglaccount","deprecated":false},{"title":"/enrichment/gl-accounts/{externalId}","summary":"Partially update general ledger account","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchglaccount","deprecated":false},{"title":"/enrichment/gl-accounts/{externalId}","summary":"Delete general ledger account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteglaccount","deprecated":false},{"title":"/enrichment/cost-centers","summary":"Insert cost center","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertcostcenter","deprecated":false},{"title":"/enrichment/cost-centers/{externalId}","summary":"Partially update cost center","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchcostcenter","deprecated":false},{"title":"/enrichment/cost-centers/{externalId}","summary":"Delete cost Center","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletecostcenter","deprecated":false},{"title":"/enrichment/approvers","summary":"Insert approver","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertapprover","deprecated":false},{"title":"/enrichment/approvers/{externalId}","summary":"Partially update approver","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchapprover","deprecated":false},{"title":"/enrichment/approvers/{externalId}","summary":"Delete approver","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteapprover","deprecated":false},{"title":"/enrichment/customers","summary":"Insert customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertcustomer","deprecated":false},{"title":"/enrichment/customers/{externalId}","summary":"Partially update customer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchcustomer","deprecated":false},{"title":"/enrichment/customers/{externalId}","summary":"Delete customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletecustomer","deprecated":false},{"title":"/enrichment/lookup-tables/{type}","summary":"Insert data row to lookup table","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertlookuptablerow","deprecated":false},{"title":"/enrichment/lookup-tables/{type}/{externalId}","summary":"Partially update data row in lookup table","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchlookuptablerow","deprecated":false},{"title":"/enrichment/lookup-tables/{type}/{externalId}","summary":"Delete data row in lookup table","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletelookuptablerow","deprecated":false},{"title":"/enrichment/contracts","summary":"Insert contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertcontract","deprecated":false},{"title":"/enrichment/contracts/{externalId}","summary":"Partially update contract","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchcontract","deprecated":false},{"title":"/enrichment/contracts/{externalId}","summary":"Delete contract","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletecontract","deprecated":false},{"title":"/enrichment/sales-orders","summary":"Insert sales order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertsalesorder","deprecated":false},{"title":"/enrichment/sales-orders/{externalId}","summary":"Partially update sales order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchsalesorder","deprecated":false},{"title":"/enrichment/sales-orders/{externalId}","summary":"Delete sales order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletesalesorder","deprecated":false},{"title":"/enrichment/products","summary":"Insert product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertproduct","deprecated":false},{"title":"/enrichment/products/{externalId}","summary":"Partially update product","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchproduct","deprecated":false},{"title":"/enrichment/products/{externalId}","summary":"Delete product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteproduct","deprecated":false},{"title":"/enrichment/customer-products","summary":"Insert customer product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertcustomerproduct","deprecated":false},{"title":"/enrichment/customer-products/{externalId}","summary":"Partially update customer product","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchcustomerproduct","deprecated":false},{"title":"/enrichment/customer-products/{externalId}","summary":"Delete customer product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletecustomerproduct","deprecated":false},{"title":"/enrichment/addresses","summary":"Insert address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertaddress","deprecated":false},{"title":"/enrichment/addresses/{externalId}","summary":"Partially update address","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchaddress","deprecated":false},{"title":"/enrichment/addresses/{externalId}","summary":"Delete address","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteaddress","deprecated":false},{"title":"/enrichment/quotes","summary":"Insert quotes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertquotes","deprecated":false},{"title":"/enrichment/quotes/{externalId}","summary":"Partially update quote","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchquotes","deprecated":false},{"title":"/enrichment/quotes/{externalId}","summary":"Delete quote","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletequotes","deprecated":false},{"title":"/enrichment/goods-receipts","summary":"Insert Goods Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertgoodsreceipts","deprecated":false},{"title":"/enrichment/goods-receipts/{externalId}","summary":"Partially update Goods Receipt","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchgoodsreceipt","deprecated":false},{"title":"/enrichment/goods-receipts/{externalId}","summary":"Delete Goods Receipt","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deletegoodsreceipt","deprecated":false},{"title":"/enrichment/profit-centers","summary":"Insert Profit Center","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertprofitcenter","deprecated":false},{"title":"/enrichment/profit-centers/{externalId}","summary":"Partially update Profit Center","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchprofitcenter","deprecated":false},{"title":"/enrichment/profit-centers/{externalId}","summary":"Delete Profit Center","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteprofitcenter","deprecated":false},{"title":"/enrichment/internal-orders","summary":"Insert Internal Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertinternalorder","deprecated":false},{"title":"/enrichment/internal-orders/{externalId}","summary":"Partially update Internal Order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchinternalorder","deprecated":false},{"title":"/enrichment/internal-orders/{externalId}","summary":"Delete Internal Order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteinternalorder","deprecated":false},{"title":"/enrichment/projects","summary":"Insert Project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment/insertproject","deprecated":false},{"title":"/enrichment/projects/{externalId}","summary":"Partially update Project","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/enrichment/patchproject","deprecated":false},{"title":"/enrichment/projects/{externalId}","summary":"Delete Project","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment/deleteproject","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/openapi/companies","routeSlug":"/openapi/companies","items":[{"label":"Retrieve a company by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/companiesgetbyid","routeSlug":"/openapi/companies/companiesgetbyid","metadata":{"seo":{"title":"Retrieve a company by id","description":"Retrieve a company by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companiesGetById","name":"Retrieve a company by id","isWebhook":false,"pointer":"/paths/~1companies~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a company by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["companies.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_17","description":"Id of the company to retrieve","required":true}],"pointer":"/paths/~1companies~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"63e6663823b4c1f5287398bb","schemaId":"components/schemas/CompaniesId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["companies.read"]}],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/companies/{id}","href":"companies/companiesgetbyid","openApiOperationId":"companiesGetById","summary":"Retrieve a company by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesResponse"}},"schemaId":"components/schemas/CompaniesResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1companies~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1companies~1{id}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/companiesgetbyid"}],"panels":[]}]},"httpPath":"/companies/{id}"},{"label":"Retrieve a list of companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/companieslist","routeSlug":"/openapi/companies/companieslist","metadata":{"seo":{"title":"Retrieve a list of companies","description":"Note: For now pagination is not implemented"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companiesList","name":"Retrieve a list of companies","isWebhook":false,"pointer":"/paths/~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Note: For now pagination is not implemented"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["companies.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["companies.read"]}],"responseCodes":["200","422","429"],"pointer":"/companies","href":"companies/companieslist","openApiOperationId":"companiesList","summary":"Retrieve a list of companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesListResponse"}},"schemaId":"components/schemas/CompaniesListResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompaniesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesListResponse"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/companieslist"}],"panels":[]}]},"httpPath":"/companies"}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for company management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{id}","summary":"Retrieve a company by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/companiesgetbyid","deprecated":false},{"title":"/companies","summary":"Retrieve a list of companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/companieslist","deprecated":false}]}]}]}]}},{"type":"group","label":"Projects","link":"/openapi/projects","routeSlug":"/openapi/projects","items":[{"label":"Create a project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/projects/projectscreate","routeSlug":"/openapi/projects/projectscreate","metadata":{"seo":{"title":"Create a project","description":"Creates a project based on the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projectsCreate","name":"Create a project","isWebhook":false,"pointer":"/paths/~1projects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a project based on the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extractionModelId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to select the default processing mode for the project type; see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section above for the rules that apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generateWordRegionsOnReview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; see the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Word regions for review"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"section above."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OCR engines can be used when creating a project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["projects.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectCreateRequest"}},"schemaId":"components/schemas/ProjectCreateRequest","pointer":"/paths/~1projects/post/requestBody","description":"Project data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["projects.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectCreateRequest"}},"responseCodes":["201","400","401","403","404","422"],"pointer":"/projects","href":"projects/projectscreate","openApiOperationId":"projectsCreate","summary":"Create a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ProjectCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Project created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectResponse"}},"schemaId":"components/schemas/ProjectResponse"},{"code":"400","description":"Response when client request is wrong","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects/post/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects/post/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects/post/responses/400/content/application~1json/examples/Default processing mode not found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects/post/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects/post/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects/post/responses/400/content/application~1json/examples/Default processing mode not found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Response when resource was not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/404/content/application~1json/examples/Project not found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/404/content/application~1json/examples/Project not found"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/post/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/post/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/post/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/post/responses/422/content/application~1json/examples/Null word regions setting"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/post/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/post/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/post/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/post/responses/422/content/application~1json/examples/Null word regions setting"]}],"pointer":"/paths/~1projects/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ProjectResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects/post/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects/post/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects/post/responses/400/content/application~1json/examples/Default processing mode not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects/post/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects/post/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects/post/responses/400/content/application~1json/examples/Default processing mode not found"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/404/content/application~1json/examples/Project not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/404/content/application~1json/examples/Project not found"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/post/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/post/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/post/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/post/responses/422/content/application~1json/examples/Null word regions setting"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/post/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/post/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/post/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/post/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/post/responses/422/content/application~1json/examples/Null word regions setting"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/projectscreate"}],"panels":[]}]},"httpPath":"/projects"},{"label":"Retrieve a projects list for given search criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/projects/projectslist","routeSlug":"/openapi/projects/projectslist","metadata":{"seo":{"title":"Retrieve a projects list for given search criteria","description":"Retrieve a projects list for given search criteria"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projectsList","name":"Retrieve a projects list for given search criteria","isWebhook":false,"pointer":"/paths/~1projects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a projects list for given search criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["projects.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_6","description":"A zero-based offset of the first item in the data collection to return."},{"name":"limit","in":"query","schemaId":"schema_7","description":"Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used."},{"name":"sort","in":"query","schemaId":"schema_18","description":"The field to sort reponse items by."},{"name":"isLive","in":"query","schemaId":"schema_11"},{"name":"search","in":"query","schemaId":"schema_19"}],"pointer":"/paths/~1projects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"schemaId":"schema_7"},{"name":"sort","in":"query","required":false,"schemaId":"schema_18"},{"name":"isLive","in":"query","required":false,"schemaId":"schema_11"},{"name":"search","in":"query","required":false,"schemaId":"schema_19"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["projects.read"]}],"responseCodes":["200","401","403","422","500"],"pointer":"/projects","href":"projects/projectslist","openApiOperationId":"projectsList","summary":"Retrieve a projects list for given search criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Projects list retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectListResponse"}},"schemaId":"components/schemas/ProjectListResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/403/content/application~1json/example"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/get/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/get/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/get/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/get/responses/422/content/application~1json/examples/Null word regions setting"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/get/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/get/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/get/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/get/responses/422/content/application~1json/examples/Null word regions setting"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1projects/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectListResponse"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/get/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/get/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/get/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/get/responses/422/content/application~1json/examples/Null word regions setting"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/422/content/application~1json/examples/Request validation error","paths/~1projects/get/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects/get/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects/get/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects/get/responses/422/content/application~1json/examples/Null word regions setting"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/projectslist"}],"panels":[]}]},"httpPath":"/projects"},{"label":"Retrieve a project by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/projects/projectsgetbyid","routeSlug":"/openapi/projects/projectsgetbyid","metadata":{"seo":{"title":"Retrieve a project by id","description":"Retrieve a project by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projectsGetById","name":"Retrieve a project by id","isWebhook":false,"pointer":"/paths/~1projects~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a project by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a project by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["projects.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Project id","required":true}],"pointer":"/paths/~1projects~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"63e6663823b4c1f5287398bb","schemaId":"components/schemas/ProjectId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["projects.read"]}],"responseCodes":["200","401","403","404"],"pointer":"/projects/{id}","href":"projects/projectsgetbyid","openApiOperationId":"projectsGetById","summary":"Retrieve a project by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project by id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectResponse"}},"schemaId":"components/schemas/ProjectResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Response when resource was not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/404/content/application~1json/examples/Project not found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/404/content/application~1json/examples/Project not found"]}],"pointer":"/paths/~1projects~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectResponse"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/404/content/application~1json/examples/Project not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/get/responses/404/content/application~1json/examples/Project not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/projectsgetbyid"}],"panels":[]}]},"httpPath":"/projects/{id}"},{"label":"Update a project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/projects/projectsupdate","routeSlug":"/openapi/projects/projectsupdate","metadata":{"seo":{"title":"Update a project","description":"Update a project by id. This endpoint supports partial updates using PATCH semantics:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projectsUpdate","name":"Update a project","isWebhook":false,"pointer":"/paths/~1projects~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a project by id. This endpoint supports partial updates using PATCH semantics:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only fields present in the request will be updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values clear the clearable fields (note, retentionDays)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absent fields will remain unchanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other fields (name, extractionModelId, ocr, completion, duplicates, isLive, generateWordRegionsOnReview, members, schema) may be omitted but cannot be set to null; sending null returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one field must be provided in the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is immutable and is not part of the update request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" projects, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extractionModelId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company's automatically selected Cases processing mode; any other value is rejected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OCR engines can be set. A project that currently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abbyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chinese"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can still be updated, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ocr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omitted from the request — sending the project's existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ocr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" block back"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unchanged is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["projects.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Project id","required":true}],"pointer":"/paths/~1projects~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectUpdateRequest"}},"schemaId":"components/schemas/ProjectUpdateRequest","pointer":"/paths/~1projects~1{id}/patch/requestBody","description":"Project update data (all fields optional for partial update)"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/projects/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"63e6663823b4c1f5287398bb","schemaId":"components/schemas/ProjectId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["projects.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectUpdateRequest"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/projects/{id}","href":"projects/projectsupdate","openApiOperationId":"projectsUpdate","summary":"Update a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ProjectUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectResponse"}},"schemaId":"components/schemas/ProjectResponse"},{"code":"400","description":"Response when client request is wrong","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Default processing mode not found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Default processing mode not found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Response when resource was not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/404/content/application~1json/examples/Project not found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/404/content/application~1json/examples/Project not found"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Request validation error","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Null word regions setting"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Request validation error","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Null word regions setting"]}],"pointer":"/paths/~1projects~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Default processing mode not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid payload data","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Extraction model not found","paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Default processing mode not found"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/404/content/application~1json/examples/Project not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/404/content/application~1json/examples/Project not found"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Request validation error","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Null word regions setting"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Request validation error","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Unsupported OCR engine","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Processing mode mismatch","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Malformed processing mode id","paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Null word regions setting"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/projectsupdate"}],"panels":[]}]},"httpPath":"/projects/{id}"},{"label":"Retrieve a schema by project id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/projects/schemasgetbyprojectid","routeSlug":"/openapi/projects/schemasgetbyprojectid","metadata":{"seo":{"title":"Retrieve a schema by project id","description":"Retrieve a schema by project id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"schemasGetByProjectId","name":"Retrieve a schema by project id","isWebhook":false,"pointer":"/paths/~1projects~1{id}~1schema/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a schema by project id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a schema by project id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["projects.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Project id","required":true}],"pointer":"/paths/~1projects~1{id}~1schema/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{id}/schema","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"63e6663823b4c1f5287398bb","schemaId":"components/schemas/ProjectId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["projects.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/projects/{id}/schema","href":"projects/schemasgetbyprojectid","openApiOperationId":"schemasGetByProjectId","summary":"Retrieve a schema by project id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Schema retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Schema"}},"schemaId":"components/schemas/Schema"},{"code":"400","description":"Response when client request is wrong","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid payload data"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid payload data"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Response when resource was not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/404/content/application~1json/examples/Project not found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/404/content/application~1json/examples/Project not found"]}],"pointer":"/paths/~1projects~1{id}~1schema/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Schema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Schema"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid payload data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid request parameter","paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid payload data"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/404/content/application~1json/examples/Project not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1projects~1{id}~1schema/get/responses/404/content/application~1json/examples/Project not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/schemasgetbyprojectid"}],"panels":[]}]},"httpPath":"/projects/{id}/schema"}],"content":{"contentType":"group","meta":{"name":"Projects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Projects","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for project management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/projects","summary":"Create a project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects/projectscreate","deprecated":false},{"title":"/projects","summary":"Retrieve a projects list for given search criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/projectslist","deprecated":false},{"title":"/projects/{id}","summary":"Retrieve a project by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/projectsgetbyid","deprecated":false},{"title":"/projects/{id}","summary":"Update a project","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/projects/projectsupdate","deprecated":false},{"title":"/projects/{id}/schema","summary":"Retrieve a schema by project id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/schemasgetbyprojectid","deprecated":false}]}]}]}]}},{"type":"group","label":"E-Invoices","link":"/openapi/e-invoices","routeSlug":"/openapi/e-invoices","items":[{"label":"Retrieve a document PDF preview for e-invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/e-invoices/retrieveeinvoicespreview","routeSlug":"/openapi/e-invoices/retrieveeinvoicespreview","metadata":{"seo":{"title":"Retrieve a document PDF preview for e-invoices","description":"Provides a binary file of a document PDF preview for e-invoices"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEInvoicesPreview","name":"Retrieve a document PDF preview for e-invoices","isWebhook":false,"pointer":"/paths/~1e-invoices~1{id}~1preview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a document PDF preview for e-invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a binary file of a document PDF preview for e-invoices"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["e-invoices.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Id of the document.","required":true}],"pointer":"/paths/~1e-invoices~1{id}~1preview/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/e-invoices/{id}/preview","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["e-invoices.read"]}],"responseCodes":["200","404","429"],"pointer":"/e-invoices/{id}/preview","href":"e-invoices/retrieveeinvoicespreview","openApiOperationId":"retrieveEInvoicesPreview","summary":"Retrieve a document PDF preview for e-invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Binary content of a file","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"}},"schemaId":"components/schemas/BinaryFile"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/documentNotFound","paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/previewNotFound"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/documentNotFound","paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/previewNotFound"]},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1e-invoices~1{id}~1preview/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BinaryFile","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/documentNotFound","paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/previewNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/documentNotFound","paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/previewNotFound"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoices/retrieveeinvoicespreview"}],"panels":[]}]},"httpPath":"/e-invoices/{id}/preview"}],"content":{"contentType":"group","meta":{"name":"E-Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for e-invoices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/e-invoices/{id}/preview","summary":"Retrieve a document PDF preview for e-invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoices/retrieveeinvoicespreview","deprecated":false}]}]}]}]}},{"type":"group","label":"Documents XML","link":"/openapi/documents-xml","routeSlug":"/openapi/documents-xml","items":[{"label":"List documents for a project as XML","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents-xml/listdocumentsxml","routeSlug":"/openapi/documents-xml/listdocumentsxml","metadata":{"seo":{"title":"List documents for a project as XML","description":"Fetches the list of documents from Studio scoped to projectId, thenapplies the transformation rule tagged {projectId}-list to produceXML. If the rule has addBinaryFile enabled, binary attachments areinlined as base64."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDocumentsXml","name":"List documents for a project as XML","isWebhook":false,"pointer":"/paths/~1document-xml~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List documents for a project as XML","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches the list of documents from Studio scoped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies the transformation rule tagged "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{projectId}-list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to produce"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XML. If the rule has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addBinaryFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled, binary attachments are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inlined as base64."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project identifier. Also selects the XSLT transformation rule applied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the Studio response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{projectId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single documents,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{projectId}-list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for lists)."},"children":[]}]}]}],"required":true},{"name":"state","in":"query","schemaId":"schema_5","description":"Filter by one or more document states (forwarded to Studio)."},{"name":"limit","in":"query","schemaId":"schema_21","description":"Maximum number of documents to return."},{"name":"offset","in":"query","schemaId":"schema_22","description":"Number of documents to skip."},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort expressions forwarded to Studio (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt,desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1document-xml~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/document-xml/documents","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"schemaId":"schema_2"},{"name":"state","in":"query","required":false,"schemaId":"schema_5","style":"form","explode":true},{"name":"limit","in":"query","required":false,"schemaId":"schema_21"},{"name":"offset","in":"query","required":false,"schemaId":"schema_22"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.read"]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/document-xml/documents","href":"documents-xml/listdocumentsxml","openApiOperationId":"listDocumentsXml","summary":"List documents for a project as XML"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transformed XML document list.","mediaType":"application/xml","mediaTypes":["application/xml"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/DocumentsXml"}},"schemaId":"components/schemas/DocumentsXml"},{"code":"400","description":"The request was malformed or missing required parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"403","description":"The caller is not permitted to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested document, or a transformation rule for the given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", was not found."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"422","description":"One or more request fields failed validation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"500","description":"An unexpected error occurred. For failures propagated from Studio, the\noriginal upstream payload is returned as XML rather than this JSON\nenvelope.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"}],"pointer":"/paths/~1document-xml~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentsXml","mediaTypes":["application/xml"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/DocumentsXml"}}},{"code":"400","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"401","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"403","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"404","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"500","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents-xml/listdocumentsxml"}],"panels":[]}]},"httpPath":"/document-xml/documents"},{"label":"Get a single document as XML","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/documents-xml/getdocumentxml","routeSlug":"/openapi/documents-xml/getdocumentxml","metadata":{"seo":{"title":"Get a single document as XML","description":"Fetches a document by id from Studio and applies the transformationrule tagged {projectId} to produce XML. If the rule hasaddBinaryFile enabled, the binary attachment is inlined as base64."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentXml","name":"Get a single document as XML","isWebhook":false,"pointer":"/paths/~1document-xml~1documents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single document as XML","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a document by id from Studio and applies the transformation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rule tagged "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{projectId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to produce XML. If the rule has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addBinaryFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled, the binary attachment is inlined as base64."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["documents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Studio document identifier.","required":true}],"pointer":"/paths/~1document-xml~1documents~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project identifier. Also selects the XSLT transformation rule applied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the Studio response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{projectId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single documents,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{projectId}-list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for lists)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1document-xml~1documents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/document-xml/documents/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"projectId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["documents.read"]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/document-xml/documents/{id}","href":"documents-xml/getdocumentxml","openApiOperationId":"getDocumentXml","summary":"Get a single document as XML"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transformed XML document.","mediaType":"application/xml","mediaTypes":["application/xml"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/DocumentXml"}},"schemaId":"components/schemas/DocumentXml"},{"code":"400","description":"The request was malformed or missing required parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"403","description":"The caller is not permitted to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested document, or a transformation rule for the given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", was not found."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"},{"code":"422","description":"One or more request fields failed validation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"500","description":"An unexpected error occurred. For failures propagated from Studio, the\noriginal upstream payload is returned as XML rather than this JSON\nenvelope.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}},"schemaId":"components/schemas/GenericError"}],"pointer":"/paths/~1document-xml~1documents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentXml","mediaTypes":["application/xml"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/DocumentXml"}}},{"code":"400","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"401","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"403","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"404","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"500","schemaId":"components/schemas/GenericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents-xml/getdocumentxml"}],"panels":[]}]},"httpPath":"/document-xml/documents/{id}"}],"content":{"contentType":"group","meta":{"name":"Documents XML"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents XML","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints serving project-scoped documents as XML"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/document-xml/documents","summary":"List documents for a project as XML","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents-xml/listdocumentsxml","deprecated":false},{"title":"/document-xml/documents/{id}","summary":"Get a single document as XML","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents-xml/getdocumentxml","deprecated":false}]}]}]}]}},{"type":"group","label":"Agent Management","link":"/openapi/agent-management","routeSlug":"/openapi/agent-management","items":[{"label":"Get Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_get_agents","routeSlug":"/openapi/agent-management/external_get_agents","metadata":{"seo":{"title":"Get Agents","description":"List agents for the authenticated company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_get_agents","name":"Get Agents","isWebhook":false,"pointer":"/paths/~1agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List agents for the authenticated company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A summary projection by default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prompt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"configuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemPrompt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outputFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toolIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are null, meaning \"not loaded\" rather than empty. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to load all five on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every row — including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"namesAndVersions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lookup, which returns whole agents but resolves tool"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"assignments only when asked. Version history is never part of a list; retrieve an agent by id for it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"namesAndVersions","in":"query","schemaId":"schema_23","description":"Comma separated list of names and versions, eg agent1:v1,agent2:v2. At most 50 entries."},{"name":"limit","in":"query","schemaId":"schema_24","description":"Maximum number of agents to return. Capped at 50; ignored when namesAndVersions is set."},{"name":"offset","in":"query","schemaId":"schema_25","description":"Number of agents to skip. Ignored when namesAndVersions is set."},{"name":"editor","in":"query","schemaId":"schema_26","description":"Return only agents whose editors contain this value. Cannot be combined with namesAndVersions."},{"name":"full","in":"query","schemaId":"schema_27","description":"Load the whole agent. In the paged list, prompt, configuration, systemPrompt, outputFormat and toolIds are null on every row by default, meaning 'not loaded' rather than empty. The namesAndVersions lookup always returns whole agents; there this flag only adds toolIds."}],"pointer":"/paths/~1agents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agents","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"namesAndVersions","in":"query","required":false,"schemaId":"schema_23"},{"name":"limit","in":"query","required":false,"schemaId":"schema_24"},{"name":"offset","in":"query","required":false,"schemaId":"schema_25"},{"name":"editor","in":"query","required":false,"schemaId":"schema_26"},{"name":"full","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agents.read"]}],"responseCodes":["200","401","403","422"],"pointer":"/agents","href":"agent-management/external_get_agents","openApiOperationId":"external_get_agents","summary":"Get Agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgentPage"}},"schemaId":"components/schemas/ExternalAgentPage"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalAgentPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgentPage"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_get_agents"}],"panels":[]}]},"httpPath":"/agents"},{"label":"Create Agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_create_agent","routeSlug":"/openapi/agent-management/external_create_agent","metadata":{"seo":{"title":"Create Agent","description":"Create a custom agent; non-default OOTB identity or source provenance returns HTTP 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_create_agent","name":"Create Agent","isWebhook":false,"pointer":"/paths/~1agents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a custom agent; non-default OOTB identity or source provenance returns HTTP 422."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAgentCreate"}},"schemaId":"components/schemas/ExternalAgentCreate","pointer":"/paths/~1agents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/agents","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agents.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalAgentCreate"}},"responseCodes":["201","401","403","422"],"pointer":"/agents","href":"agent-management/external_create_agent","openApiOperationId":"external_create_agent","summary":"Create Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ExternalAgentCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAgentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}},"schemaId":"components/schemas/ExternalAgent"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agents/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExternalAgent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_create_agent"}],"panels":[]}]},"httpPath":"/agents"},{"label":"Get Agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_get_agent","routeSlug":"/openapi/agent-management/external_get_agent","metadata":{"seo":{"title":"Get Agent","description":"Get Agent"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_get_agent","name":"Get Agent","isWebhook":false,"pointer":"/paths/~1agents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agents.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agents~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"withVersions","in":"query","schemaId":"schema_29","description":"Whether to load versions"},{"name":"withVersionsMetadata","in":"query","schemaId":"schema_30","description":"Whether to load lightweight version metadata (id, version, description, createdAt, createdBy)"}],"pointer":"/paths/~1agents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agents/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[{"name":"withVersions","in":"query","required":false,"schemaId":"schema_29"},{"name":"withVersionsMetadata","in":"query","required":false,"schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agents.read"]}],"responseCodes":["200","401","403","404","422"],"pointer":"/agents/{id}","href":"agent-management/external_get_agent","openApiOperationId":"external_get_agent","summary":"Get Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}},"schemaId":"components/schemas/ExternalAgent"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalAgent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_get_agent"}],"panels":[]}]},"httpPath":"/agents/{id}"},{"label":"Update Agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_update_agent","routeSlug":"/openapi/agent-management/external_update_agent","metadata":{"seo":{"title":"Update Agent","description":"Replace a custom agent. Persisted OOTB agents return HTTP 422; use root PATCH to customize them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_update_agent","name":"Update Agent","isWebhook":false,"pointer":"/paths/~1agents~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replace a custom agent. Persisted OOTB agents return HTTP 422; use root PATCH to customize them."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agents~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAgentWrite"}},"schemaId":"components/schemas/ExternalAgentWrite","pointer":"/paths/~1agents~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/agents/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agents.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalAgentWrite"}},"responseCodes":["200","401","403","404","422"],"pointer":"/agents/{id}","href":"agent-management/external_update_agent","openApiOperationId":"external_update_agent","summary":"Update Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ExternalAgentWrite","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAgentWrite"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}},"schemaId":"components/schemas/ExternalAgent"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agents~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalAgent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_update_agent"}],"panels":[]}]},"httpPath":"/agents/{id}"},{"label":"Patch Agent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_patch_agent","routeSlug":"/openapi/agent-management/external_patch_agent","metadata":{"seo":{"title":"Patch Agent","description":"Patch by persisted kind: OOTB allows prompt/description/editors/outputFormat; custom keeps partial-update semantics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_patch_agent","name":"Patch Agent","isWebhook":false,"pointer":"/paths/~1agents~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch by persisted kind: OOTB allows prompt/description/editors/outputFormat;\ncustom keeps partial-update semantics.\n\nFor custom agents, omitted fields stay unchanged, explicit null clears nullable fields, and companyId and\nname are immutable. A custom-only or otherwise protected field sent to an OOTB agent is rejected with 422."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agents~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31","pointer":"/paths/~1agents~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/agents/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agents.write"]}],"requestBody":{"application/json":{"schemaId":"schema_31"}},"responseCodes":["200","401","403","404","422"],"pointer":"/agents/{id}","href":"agent-management/external_patch_agent","openApiOperationId":"external_patch_agent","summary":"Patch Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}},"schemaId":"components/schemas/ExternalAgent"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agents~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalAgent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalAgent"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_patch_agent"}],"panels":[]}]},"httpPath":"/agents/{id}"},{"label":"Delete Agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_delete_agent","routeSlug":"/openapi/agent-management/external_delete_agent","metadata":{"seo":{"title":"Delete Agent","description":"Delete Agent"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_delete_agent","name":"Delete Agent","isWebhook":false,"pointer":"/paths/~1agents~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agents.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agents~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/agents/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agents.write"]}],"responseCodes":["204","401","403","404","422"],"pointer":"/agents/{id}","href":"agent-management/external_delete_agent","openApiOperationId":"external_delete_agent","summary":"Delete Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agents~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_delete_agent"}],"panels":[]}]},"httpPath":"/agents/{id}"},{"label":"Get Workflows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_get_workflows","routeSlug":"/openapi/agent-management/external_get_workflows","metadata":{"seo":{"title":"Get Workflows","description":"Get Workflows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_get_workflows","name":"Get Workflows","isWebhook":false,"pointer":"/paths/~1agent-workflows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agent-workflows.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_32","description":"The ID of the project"},{"name":"limit","in":"query","schemaId":"schema_33","description":"Maximum number of workflows to return. Capped at 50."},{"name":"offset","in":"query","schemaId":"schema_34","description":"Number of workflows to skip."},{"name":"editor","in":"query","schemaId":"schema_35","description":"Return only workflows whose editors contain this value."}],"pointer":"/paths/~1agent-workflows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agent-workflows","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":false,"schemaId":"schema_32"},{"name":"limit","in":"query","required":false,"schemaId":"schema_33"},{"name":"offset","in":"query","required":false,"schemaId":"schema_34"},{"name":"editor","in":"query","required":false,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agent-workflows.read"]}],"responseCodes":["200","401","403","422"],"pointer":"/agent-workflows","href":"agent-management/external_get_workflows","openApiOperationId":"external_get_workflows","summary":"Get Workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowPage"}},"schemaId":"components/schemas/ExternalWorkflowPage"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agent-workflows/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalWorkflowPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowPage"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_get_workflows"}],"panels":[]}]},"httpPath":"/agent-workflows"},{"label":"Create Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_create_workflow","routeSlug":"/openapi/agent-management/external_create_workflow","metadata":{"seo":{"title":"Create Workflow","description":"Create a custom workflow; OOTB identity or source provenance in the request returns HTTP 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_create_workflow","name":"Create Workflow","isWebhook":false,"pointer":"/paths/~1agent-workflows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a custom workflow; OOTB identity or source provenance in the request returns HTTP 422."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agent-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowCreate"}},"schemaId":"components/schemas/ExternalWorkflowCreate","pointer":"/paths/~1agent-workflows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/agent-workflows","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agent-workflows.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowCreate"}},"responseCodes":["201","401","403","422"],"pointer":"/agent-workflows","href":"agent-management/external_create_workflow","openApiOperationId":"external_create_workflow","summary":"Create Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ExternalWorkflowCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}},"schemaId":"components/schemas/ExternalWorkflow"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agent-workflows/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExternalWorkflow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_create_workflow"}],"panels":[]}]},"httpPath":"/agent-workflows"},{"label":"Get Workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_get_workflow","routeSlug":"/openapi/agent-management/external_get_workflow","metadata":{"seo":{"title":"Get Workflow","description":"Get Workflow"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_get_workflow","name":"Get Workflow","isWebhook":false,"pointer":"/paths/~1agent-workflows~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agent-workflows.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agent-workflows~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agent-workflows/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agent-workflows.read"]}],"responseCodes":["200","401","403","404","422"],"pointer":"/agent-workflows/{id}","href":"agent-management/external_get_workflow","openApiOperationId":"external_get_workflow","summary":"Get Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}},"schemaId":"components/schemas/ExternalWorkflow"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agent-workflows~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalWorkflow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_get_workflow"}],"panels":[]}]},"httpPath":"/agent-workflows/{id}"},{"label":"Update Workflow","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_update_workflow","routeSlug":"/openapi/agent-management/external_update_workflow","metadata":{"seo":{"title":"Update Workflow","description":"Replace a custom workflow. Persisted OOTB workflows return HTTP 422; use root PATCH to customize them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_update_workflow","name":"Update Workflow","isWebhook":false,"pointer":"/paths/~1agent-workflows~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replace a custom workflow. Persisted OOTB workflows return HTTP 422; use root PATCH to customize them."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agent-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agent-workflows~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowWrite"}},"schemaId":"components/schemas/ExternalWorkflowWrite","pointer":"/paths/~1agent-workflows~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/agent-workflows/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agent-workflows.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowWrite"}},"responseCodes":["200","401","403","404","422"],"pointer":"/agent-workflows/{id}","href":"agent-management/external_update_workflow","openApiOperationId":"external_update_workflow","summary":"Update Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ExternalWorkflowWrite","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalWorkflowWrite"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}},"schemaId":"components/schemas/ExternalWorkflow"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agent-workflows~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalWorkflow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_update_workflow"}],"panels":[]}]},"httpPath":"/agent-workflows/{id}"},{"label":"Patch Workflow","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_patch_workflow","routeSlug":"/openapi/agent-management/external_patch_workflow","metadata":{"seo":{"title":"Patch Workflow","description":"Patch by persisted kind after ownership is established."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_patch_workflow","name":"Patch Workflow","isWebhook":false,"pointer":"/paths/~1agent-workflows~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch by persisted kind after ownership is established.\n\nOOTB workflows accept only workflowConfiguration.steps, name, description, projects, and editors;\na protected field sent to an OOTB workflow is rejected with 422. Custom workflows keep their existing\npartial-update contract."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agent-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agent-workflows~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","pointer":"/paths/~1agent-workflows~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/agent-workflows/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agent-workflows.write"]}],"requestBody":{"application/json":{"schemaId":"schema_36"}},"responseCodes":["200","401","403","404","422"],"pointer":"/agent-workflows/{id}","href":"agent-management/external_patch_workflow","openApiOperationId":"external_patch_workflow","summary":"Patch Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}},"schemaId":"components/schemas/ExternalWorkflow"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agent-workflows~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalWorkflow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalWorkflow"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_patch_workflow"}],"panels":[]}]},"httpPath":"/agent-workflows/{id}"},{"label":"Delete Workflow","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agent-management/external_delete_workflow","routeSlug":"/openapi/agent-management/external_delete_workflow","metadata":{"seo":{"title":"Delete Workflow","description":"Delete Workflow"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"external_delete_workflow","name":"Delete Workflow","isWebhook":false,"pointer":"/paths/~1agent-workflows~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["agent-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_28","required":true}],"pointer":"/paths/~1agent-workflows~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/agent-workflows/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["agent-workflows.write"]}],"responseCodes":["204","401","403","404","422"],"pointer":"/agent-workflows/{id}","href":"agent-management/external_delete_workflow","openApiOperationId":"external_delete_workflow","summary":"Delete Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1agent-workflows~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent-management/external_delete_workflow"}],"panels":[]}]},"httpPath":"/agent-workflows/{id}"}],"content":{"contentType":"group","meta":{"name":"Agent Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agent Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing agents and agent workflows"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/agents","summary":"Get Agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent-management/external_get_agents","deprecated":false},{"title":"/agents","summary":"Create Agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent-management/external_create_agent","deprecated":false},{"title":"/agents/{id}","summary":"Get Agent","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent-management/external_get_agent","deprecated":false},{"title":"/agents/{id}","summary":"Update Agent","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent-management/external_update_agent","deprecated":false},{"title":"/agents/{id}","summary":"Patch Agent","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agent-management/external_patch_agent","deprecated":false},{"title":"/agents/{id}","summary":"Delete Agent","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent-management/external_delete_agent","deprecated":false},{"title":"/agent-workflows","summary":"Get Workflows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent-management/external_get_workflows","deprecated":false},{"title":"/agent-workflows","summary":"Create Workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent-management/external_create_workflow","deprecated":false},{"title":"/agent-workflows/{id}","summary":"Get Workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent-management/external_get_workflow","deprecated":false},{"title":"/agent-workflows/{id}","summary":"Update Workflow","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent-management/external_update_workflow","deprecated":false},{"title":"/agent-workflows/{id}","summary":"Patch Workflow","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agent-management/external_patch_workflow","deprecated":false},{"title":"/agent-workflows/{id}","summary":"Delete Workflow","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent-management/external_delete_workflow","deprecated":false}]}]}]}]}},{"type":"group","label":"Context Variables","link":"/openapi/context-variables","routeSlug":"/openapi/context-variables","items":[{"label":"Get configuration variables for a scope","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/context-variables/getconfigurationvariables","routeSlug":"/openapi/context-variables/getconfigurationvariables","metadata":{"seo":{"title":"Get configuration variables for a scope","description":"Get configuration variables for a specific scope. If no scopeType/scopeId is provided, returns company-level variables."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConfigurationVariables","name":"Get configuration variables for a scope","isWebhook":false,"pointer":"/paths/~1context-vars~1configurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get configuration variables for a scope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get configuration variables for a specific scope. If no scopeType/scopeId is provided, returns company-level variables.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["context-vars.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"scopeType","in":"query","schemaId":"schema_37"},{"name":"scopeId","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1context-vars~1configurations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Hy-Meta-Internal-Company-Id","in":"header","schemaId":"schema_2","description":"Company ID for service account authorization"}],"pointer":"/paths/~1context-vars~1configurations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/context-vars/configurations","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"scopeType","in":"query","required":false,"schemaId":"components/schemas/ScopeType"},{"name":"scopeId","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"X-Hy-Meta-Internal-Company-Id","in":"header","required":false,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["context-vars.read"]}],"responseCodes":["200","400","401","403","500"],"pointer":"/context-vars/configurations","href":"context-variables/getconfigurationvariables","openApiOperationId":"getConfigurationVariables","summary":"Get configuration variables for a scope"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Configuration variables for the scope. Returns empty variables list if no configuration exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigurationScope"}},"schemaId":"components/schemas/ConfigurationScope"},{"code":"400","description":"Bad request - invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - missing or invalid authentication token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - the token lacks the context-vars.read scope","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1context-vars~1configurations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConfigurationScope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigurationScope"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context-variables/getconfigurationvariables"}],"panels":[]}]},"httpPath":"/context-vars/configurations"},{"label":"Set configuration variables for a scope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/context-variables/setconfigurationvariables","routeSlug":"/openapi/context-variables/setconfigurationvariables","metadata":{"seo":{"title":"Set configuration variables for a scope","description":"Create or replace configuration variables for a given scope. If no scopeType/scopeId is provided, sets company-level variables. Every variable created, updated or deleted is recorded in the audit log under the acting user: the token's subject (the client id of a service account), or when that is blank, the X-Hy-Meta-User-Id header."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setConfigurationVariables","name":"Set configuration variables for a scope","isWebhook":false,"pointer":"/paths/~1context-vars~1configurations/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set configuration variables for a scope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or replace configuration variables for a given scope. If no scopeType/scopeId is provided, sets company-level variables. Every variable created, updated or deleted is recorded in the audit log under the acting user: the token's subject (the client id of a service account), or when that is blank, the X-Hy-Meta-User-Id header.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["context-vars.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Hy-Meta-Internal-Company-Id","in":"header","schemaId":"schema_2","description":"Company ID for service account authorization"},{"name":"X-Hy-Meta-User-Id","in":"header","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hypatos user id of the acting user, recorded as the audit log actor and stored as the scope's created_by/updated_by so both agree. The token's subject takes precedence, so with a service account token the client id is recorded and this header is read only when the subject is blank. It in turn takes precedence over the body's deprecated updatedBy."},"children":[]}]}]}]}],"pointer":"/paths/~1context-vars~1configurations/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConfigurationScopeRequest","exampleIds":["paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel","paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel"]}},"schemaId":"components/schemas/ConfigurationScopeRequest","exampleIds":["paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel","paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel"],"pointer":"/paths/~1context-vars~1configurations/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/context-vars/configurations","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Hy-Meta-Internal-Company-Id","in":"header","required":false,"schemaId":"schema_2"},{"name":"X-Hy-Meta-User-Id","in":"header","required":false,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["context-vars.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConfigurationScopeRequest","exampleIds":["paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel","paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel"]}},"responseCodes":["200","201","400","401","403","422","500"],"pointer":"/context-vars/configurations","href":"context-variables/setconfigurationvariables","openApiOperationId":"setConfigurationVariables","summary":"Set configuration variables for a scope"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ConfigurationScopeRequest","exampleIds":["paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel","paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConfigurationScopeRequest","exampleIds":["paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel","paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Configuration updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigurationScope"}},"schemaId":"components/schemas/ConfigurationScope"},{"code":"201","description":"Configuration created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigurationScope"}},"schemaId":"components/schemas/ConfigurationScope"},{"code":"400","description":"Bad request - validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - missing or invalid authentication token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - the token lacks the context-vars.write scope","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable entity - invalid request body format, or no acting user could be determined from the token's subject, the X-Hy-Meta-User-Id header or the body's updatedBy\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1context-vars~1configurations/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConfigurationScope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigurationScope"}}},{"code":"201","schemaId":"components/schemas/ConfigurationScope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigurationScope"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context-variables/setconfigurationvariables"}],"panels":[]}]},"httpPath":"/context-vars/configurations"},{"label":"Resolve context variables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/context-variables/resolvecontextvariables","routeSlug":"/openapi/context-variables/resolvecontextvariables","metadata":{"seo":{"title":"Resolve context variables","description":"Resolve configuration variables for a given context defined by project, workflow, and agent identifiers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resolveContextVariables","name":"Resolve context variables","isWebhook":false,"pointer":"/paths/~1context-vars~1resolve/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve context variables","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resolve configuration variables for a given context defined by project, workflow, and agent identifiers"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["context-vars.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_2","description":"Project identifier","example":"66e80e8f4e8215461076e24b"},{"name":"psWorkflowId","in":"query","schemaId":"schema_2","description":"PS Workflow identifier","example":"586b096e-8de9-4652-9664-866112d0ae55"},{"name":"psAgentId","in":"query","schemaId":"schema_2","description":"PS Agent identifier","example":"29fbdb9d-d64c-4953-a45f-7a755e9a6d21"},{"name":"ceWorkflowId","in":"query","schemaId":"schema_2","description":"CE Workflow identifier","example":"cb051111-3732-4d0f-8f3e-c30c1f1ba3e2"}],"pointer":"/paths/~1context-vars~1resolve/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Hy-Meta-Internal-Company-Id","in":"header","schemaId":"schema_2","description":"Company ID for service account authorization"}],"pointer":"/paths/~1context-vars~1resolve/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/context-vars/resolve","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":false,"example":"66e80e8f4e8215461076e24b","schemaId":"schema_2"},{"name":"psWorkflowId","in":"query","required":false,"example":"586b096e-8de9-4652-9664-866112d0ae55","schemaId":"schema_2"},{"name":"psAgentId","in":"query","required":false,"example":"29fbdb9d-d64c-4953-a45f-7a755e9a6d21","schemaId":"schema_2"},{"name":"ceWorkflowId","in":"query","required":false,"example":"cb051111-3732-4d0f-8f3e-c30c1f1ba3e2","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"X-Hy-Meta-Internal-Company-Id","in":"header","required":false,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["context-vars.read"]}],"responseCodes":["200","401","403","500"],"pointer":"/context-vars/resolve","href":"context-variables/resolvecontextvariables","openApiOperationId":"resolveContextVariables","summary":"Resolve context variables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully resolved context variables","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1context-vars~1resolve/get/responses/200/content/application~1json/examples/example1"]}},"schemaId":"schema_38","exampleIds":["paths/~1context-vars~1resolve/get/responses/200/content/application~1json/examples/example1"]},{"code":"401","description":"Unauthorized - missing or invalid authentication token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - the token lacks the context-vars.read scope","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1context-vars~1resolve/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","exampleIds":["paths/~1context-vars~1resolve/get/responses/200/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1context-vars~1resolve/get/responses/200/content/application~1json/examples/example1"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context-variables/resolvecontextvariables"}],"panels":[]}]},"httpPath":"/context-vars/resolve"}],"content":{"contentType":"group","meta":{"name":"Context Variables"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Context Variables","showPageActions":true},{"nodeType":"markdoc","content":"Company configuration variables, set per company, project, workflow or agent and resolved by precedence."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/context-vars/configurations","summary":"Get configuration variables for a scope","prefix":{"name":"get","color":"get"},"badges":[],"link":"/context-variables/getconfigurationvariables","deprecated":false},{"title":"/context-vars/configurations","summary":"Set configuration variables for a scope","prefix":{"name":"put","color":"put"},"badges":[],"link":"/context-variables/setconfigurationvariables","deprecated":false},{"title":"/context-vars/resolve","summary":"Resolve context variables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/context-variables/resolvecontextvariables","deprecated":false}]}]}]}]}},{"type":"group","label":"Emails","link":"/openapi/emails","routeSlug":"/openapi/emails","items":[{"label":"Retrieve an email merged content for given document ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/emailscontentgetbydocumentid","routeSlug":"/openapi/emails/emailscontentgetbydocumentid","metadata":{"seo":{"title":"Retrieve an email merged content for given document ID","description":"Retrieve an email merged content for given document ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"emailsContentGetByDocumentId","name":"Retrieve an email merged content for given document ID","isWebhook":false,"pointer":"/paths/~1emails~1{id}~1content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an email merged content for given document ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["emails.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_39","required":true,"example":"6295dcd39db1ab740c3e296c"}],"pointer":"/paths/~1emails~1{id}~1content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/{id}/content","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6295dcd39db1ab740c3e296c","schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["emails.read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/emails/{id}/content","href":"emails/emailscontentgetbydocumentid","openApiOperationId":"emailsContentGetByDocumentId","summary":"Retrieve an email merged content for given document ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"}},"schemaId":"components/schemas/BinaryFile"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1emails~1{id}~1content/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BinaryFile","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/BinaryFile"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1content/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/emails/emailscontentgetbydocumentid"}],"panels":[]}]},"httpPath":"/emails/{id}/content"},{"label":"Retrieve an email metadata for given document ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/emailsmetadatagetbydocumentid","routeSlug":"/openapi/emails/emailsmetadatagetbydocumentid","metadata":{"seo":{"title":"Retrieve an email metadata for given document ID","description":"Retrieve an email metadata for given document ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"emailsMetadataGetByDocumentId","name":"Retrieve an email metadata for given document ID","isWebhook":false,"pointer":"/paths/~1emails~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an email metadata for given document ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["emails.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_39","required":true,"example":"6295dcd39db1ab740c3e296c"}],"pointer":"/paths/~1emails~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6295dcd39db1ab740c3e296c","schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["emails.read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/emails/{id}","href":"emails/emailsmetadatagetbydocumentid","openApiOperationId":"emailsMetadataGetByDocumentId","summary":"Retrieve an email metadata for given document ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailResponse"}},"schemaId":"components/schemas/EmailResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1emails~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailResponse"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/emails/emailsmetadatagetbydocumentid"}],"panels":[]}]},"httpPath":"/emails/{id}"},{"label":"Retrieve an email eml content for given document ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/emailsemlgetbydocumentid","routeSlug":"/openapi/emails/emailsemlgetbydocumentid","metadata":{"seo":{"title":"Retrieve an email eml content for given document ID","description":"Retrieve an email eml content for given document ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"emailsEmlGetByDocumentId","name":"Retrieve an email eml content for given document ID","isWebhook":false,"pointer":"/paths/~1emails~1{id}~1eml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an email eml content for given document ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["emails.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_39","required":true,"example":"6295dcd39db1ab740c3e296c"}],"pointer":"/paths/~1emails~1{id}~1eml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/{id}/eml","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6295dcd39db1ab740c3e296c","schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["emails.read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/emails/{id}/eml","href":"emails/emailsemlgetbydocumentid","openApiOperationId":"emailsEmlGetByDocumentId","summary":"Retrieve an email eml content for given document ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/BinaryFile"}},"schemaId":"components/schemas/BinaryFile"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1emails~1{id}~1eml/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BinaryFile","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/BinaryFile"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1emails~1{id}~1eml/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/emails/emailsemlgetbydocumentid"}],"panels":[]}]},"httpPath":"/emails/{id}/eml"}],"content":{"contentType":"group","meta":{"name":"Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Emails","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/emails/{id}/content","summary":"Retrieve an email merged content for given document ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/emailscontentgetbydocumentid","deprecated":false},{"title":"/emails/{id}","summary":"Retrieve an email metadata for given document ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/emailsmetadatagetbydocumentid","deprecated":false},{"title":"/emails/{id}/eml","summary":"Retrieve an email eml content for given document ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/emailsemlgetbydocumentid","deprecated":false}]}]}]}]}},{"type":"group","label":"Document Routing","link":"/openapi/document-routing","routeSlug":"/openapi/document-routing","items":[{"label":"Retrieve document routing with given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/document-routing/routingsgetbyid","routeSlug":"/openapi/document-routing/routingsgetbyid","metadata":{"seo":{"title":"Retrieve document routing with given id","description":"Retrieve document routing with given id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routingsGetById","name":"Retrieve document routing with given id","isWebhook":false,"pointer":"/paths/~1routings~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve document routing with given id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["routings.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_40","required":true}],"pointer":"/paths/~1routings~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/routings/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6295dcd39db1ab740c3e296c","schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["routings.read"]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/routings/{id}","href":"document-routing/routingsgetbyid","openApiOperationId":"routingsGetById","summary":"Retrieve document routing with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingResponse"}},"schemaId":"components/schemas/RoutingResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1routings~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoutingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-routing/routingsgetbyid"}],"panels":[]}]},"httpPath":"/routings/{id}"},{"label":"Update document routing","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/document-routing/routingsupdate","routeSlug":"/openapi/document-routing/routingsupdate","metadata":{"seo":{"title":"Update document routing","description":"Update document routing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routingsUpdate","name":"Update document routing","isWebhook":false,"pointer":"/paths/~1routings~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update document routing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["routings.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_41","required":true}],"pointer":"/paths/~1routings~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRoutingRequest"}},"schemaId":"components/schemas/UpdateRoutingRequest","pointer":"/paths/~1routings~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/routings/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["routings.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRoutingRequest"}},"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/routings/{id}","href":"document-routing/routingsupdate","openApiOperationId":"routingsUpdate","summary":"Update document routing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateRoutingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRoutingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingResponse"}},"schemaId":"components/schemas/RoutingResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1routings~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoutingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-routing/routingsupdate"}],"panels":[]}]},"httpPath":"/routings/{id}"},{"label":"Delete document routing","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/document-routing/routingsdelete","routeSlug":"/openapi/document-routing/routingsdelete","metadata":{"seo":{"title":"Delete document routing","description":"Delete document routing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routingsDelete","name":"Delete document routing","isWebhook":false,"pointer":"/paths/~1routings~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete document routing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["routings.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_42","required":true}],"pointer":"/paths/~1routings~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/routings/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["routings.write"]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/routings/{id}","href":"document-routing/routingsdelete","openApiOperationId":"routingsDelete","summary":"Delete document routing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1routings~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-routing/routingsdelete"}],"panels":[]}]},"httpPath":"/routings/{id}"},{"label":"Retrieve document routings list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/document-routing/routingslist","routeSlug":"/openapi/document-routing/routingslist","metadata":{"seo":{"title":"Retrieve document routings list","description":"Retrieve document routings list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routingsList","name":"Retrieve document routings list","isWebhook":false,"pointer":"/paths/~1routings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve document routings list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["routings.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_43"},{"name":"offset","in":"query","schemaId":"schema_44"}],"pointer":"/paths/~1routings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/routings","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_43"},{"name":"offset","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["routings.read"]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/routings","href":"document-routing/routingslist","openApiOperationId":"routingsList","summary":"Retrieve document routings list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingListResponse"}},"schemaId":"components/schemas/RoutingListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1routings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoutingListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingListResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-routing/routingslist"}],"panels":[]}]},"httpPath":"/routings"},{"label":"Create document routing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/document-routing/routingscreate","routeSlug":"/openapi/document-routing/routingscreate","metadata":{"seo":{"title":"Create document routing","description":"Create document routing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routingsCreate","name":"Create document routing","isWebhook":false,"pointer":"/paths/~1routings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create document routing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["routings.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRoutingRequest"}},"schemaId":"components/schemas/CreateRoutingRequest","pointer":"/paths/~1routings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/routings","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["routings.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRoutingRequest"}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/routings","href":"document-routing/routingscreate","openApiOperationId":"routingsCreate","summary":"Create document routing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateRoutingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRoutingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingResponse"}},"schemaId":"components/schemas/RoutingResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1routings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/RoutingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoutingResponse"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-routing/routingscreate"}],"panels":[]}]},"httpPath":"/routings"},{"label":"Change document routing order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/document-routing/routingsorder","routeSlug":"/openapi/document-routing/routingsorder","metadata":{"seo":{"title":"Change document routing order","description":"Change document routing order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routingsOrder","name":"Change document routing order","isWebhook":false,"pointer":"/paths/~1routings~1{id}~1order/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change document routing order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["routings.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_42","required":true}],"pointer":"/paths/~1routings~1{id}~1order/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RoutingOrderRequest"}},"schemaId":"components/schemas/RoutingOrderRequest","pointer":"/paths/~1routings~1{id}~1order/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/routings/{id}/order","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["routings.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RoutingOrderRequest"}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/routings/{id}/order","href":"document-routing/routingsorder","openApiOperationId":"routingsOrder","summary":"Change document routing order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/RoutingOrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RoutingOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1routings~1{id}~1order/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1routings~1{id}~1order/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-routing/routingsorder"}],"panels":[]}]},"httpPath":"/routings/{id}/order"}],"content":{"contentType":"group","meta":{"name":"Document Routing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document Routing","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/routings/{id}","summary":"Retrieve document routing with given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-routing/routingsgetbyid","deprecated":false},{"title":"/routings/{id}","summary":"Update document routing","prefix":{"name":"put","color":"put"},"badges":[],"link":"/document-routing/routingsupdate","deprecated":false},{"title":"/routings/{id}","summary":"Delete document routing","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/document-routing/routingsdelete","deprecated":false},{"title":"/routings","summary":"Retrieve document routings list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-routing/routingslist","deprecated":false},{"title":"/routings","summary":"Create document routing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document-routing/routingscreate","deprecated":false},{"title":"/routings/{id}/order","summary":"Change document routing order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document-routing/routingsorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Enrichment workflows","link":"/openapi/enrichment-workflows","routeSlug":"/openapi/enrichment-workflows","items":[{"label":"Get all enrichment workflow definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment-workflows/getallworkflowdefinitions","routeSlug":"/openapi/enrichment-workflows/getallworkflowdefinitions","metadata":{"seo":{"title":"Get all enrichment workflow definitions","description":"Get all enrichment workflow definitions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllWorkflowDefinitions","name":"Get all enrichment workflow definitions","isWebhook":false,"pointer":"/paths/~1enrichment-workflows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all enrichment workflow definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment-workflows.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_45","description":"A zero-based offset of the first item in the data collection to return."},{"name":"limit","in":"query","schemaId":"schema_7","description":"Limit the amount of items returned. Values above the maximum are capped."}],"pointer":"/paths/~1enrichment-workflows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enrichment-workflows","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_45"},{"name":"limit","in":"query","required":false,"schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment-workflows.read"]}],"responseCodes":["200","400","401","403","429"],"pointer":"/enrichment-workflows","href":"enrichment-workflows/getallworkflowdefinitions","openApiOperationId":"getAllWorkflowDefinitions","summary":"Get all enrichment workflow definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionsListResponse"}},"schemaId":"components/schemas/WorkflowDefinitionsListResponse"},{"code":"400","description":"The request was malformed or contained invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"401","description":"Unauthorized - missing or invalid bearer token"},{"code":"403","description":"Forbidden - bearer token lacks the required scope or target company access"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment-workflows/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinitionsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionsListResponse"}}},{"code":"400","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment-workflows/getallworkflowdefinitions"}],"panels":[]}]},"httpPath":"/enrichment-workflows"},{"label":"Create enrichment workflow definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment-workflows/createworkflowdefinition","routeSlug":"/openapi/enrichment-workflows/createworkflowdefinition","metadata":{"seo":{"title":"Create enrichment workflow definition","description":"Create enrichment workflow definition"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWorkflowDefinition","name":"Create enrichment workflow definition","isWebhook":false,"pointer":"/paths/~1enrichment-workflows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create enrichment workflow definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionRequest"}},"schemaId":"components/schemas/WorkflowDefinitionRequest","pointer":"/paths/~1enrichment-workflows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enrichment-workflows","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment-workflows.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionRequest"}},"responseCodes":["201","400","401","403","429"],"pointer":"/enrichment-workflows","href":"enrichment-workflows/createworkflowdefinition","openApiOperationId":"createWorkflowDefinition","summary":"Create enrichment workflow definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/WorkflowDefinitionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Workflow definition created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition"}},"schemaId":"components/schemas/WorkflowDefinition"},{"code":"400","description":"The request was malformed or contained invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"401","description":"Unauthorized - missing or invalid bearer token"},{"code":"403","description":"Forbidden - bearer token lacks the required scope or target company access"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment-workflows/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WorkflowDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition"}}},{"code":"400","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment-workflows/createworkflowdefinition"}],"panels":[]}]},"httpPath":"/enrichment-workflows"},{"label":"Get enrichment workflow definition by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment-workflows/getworkflowdefinition","routeSlug":"/openapi/enrichment-workflows/getworkflowdefinition","metadata":{"seo":{"title":"Get enrichment workflow definition by ID","description":"Get enrichment workflow definition by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowDefinition","name":"Get enrichment workflow definition by ID","isWebhook":false,"pointer":"/paths/~1enrichment-workflows~1{workflowId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get enrichment workflow definition by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment-workflows.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_46","description":"ID of the workflow to be read","required":true}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enrichment-workflows/{workflowId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment-workflows.read"]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/enrichment-workflows/{workflowId}","href":"enrichment-workflows/getworkflowdefinition","openApiOperationId":"getWorkflowDefinition","summary":"Get enrichment workflow definition by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition"}},"schemaId":"components/schemas/WorkflowDefinition"},{"code":"400","description":"The request was malformed or contained invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"401","description":"Unauthorized - missing or invalid bearer token"},{"code":"403","description":"Forbidden - bearer token lacks the required scope or target company access"},{"code":"404","description":"Workflow definition not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition"}}},{"code":"400","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment-workflows/getworkflowdefinition"}],"panels":[]}]},"httpPath":"/enrichment-workflows/{workflowId}"},{"label":"Update existing enrichment workflow definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment-workflows/updateworkflowdefinition","routeSlug":"/openapi/enrichment-workflows/updateworkflowdefinition","metadata":{"seo":{"title":"Update existing enrichment workflow definition","description":"Update existing enrichment workflow definition"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWorkflowDefinition","name":"Update existing enrichment workflow definition","isWebhook":false,"pointer":"/paths/~1enrichment-workflows~1{workflowId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update existing enrichment workflow definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_46","description":"ID of the workflow to be updated","required":true}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionRequest"}},"schemaId":"components/schemas/WorkflowDefinitionRequest","pointer":"/paths/~1enrichment-workflows~1{workflowId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/enrichment-workflows/{workflowId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment-workflows.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionRequest"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/enrichment-workflows/{workflowId}","href":"enrichment-workflows/updateworkflowdefinition","openApiOperationId":"updateWorkflowDefinition","summary":"Update existing enrichment workflow definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/WorkflowDefinitionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow definition updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition"}},"schemaId":"components/schemas/WorkflowDefinition"},{"code":"400","description":"The request was malformed or contained invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"401","description":"Unauthorized - missing or invalid bearer token"},{"code":"403","description":"Forbidden - bearer token lacks the required scope or target company access"},{"code":"404","description":"Workflow definition not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition"}}},{"code":"400","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment-workflows/updateworkflowdefinition"}],"panels":[]}]},"httpPath":"/enrichment-workflows/{workflowId}"},{"label":"Delete enrichment workflow definition by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment-workflows/deleteworkflowdefinition","routeSlug":"/openapi/enrichment-workflows/deleteworkflowdefinition","metadata":{"seo":{"title":"Delete enrichment workflow definition by ID","description":"Delete enrichment workflow definition by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWorkflowDefinition","name":"Delete enrichment workflow definition by ID","isWebhook":false,"pointer":"/paths/~1enrichment-workflows~1{workflowId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete enrichment workflow definition by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment-workflows.write"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_46","description":"ID of the workflow to be deleted","required":true}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enrichment-workflows/{workflowId}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment-workflows.write"]}],"responseCodes":["204","400","401","403","404","429"],"pointer":"/enrichment-workflows/{workflowId}","href":"enrichment-workflows/deleteworkflowdefinition","openApiOperationId":"deleteWorkflowDefinition","summary":"Delete enrichment workflow definition by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workflow definition deleted"},{"code":"400","description":"The request was malformed or contained invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"401","description":"Unauthorized - missing or invalid bearer token"},{"code":"403","description":"Forbidden - bearer token lacks the required scope or target company access"},{"code":"404","description":"Workflow definition not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment-workflows/deleteworkflowdefinition"}],"panels":[]}]},"httpPath":"/enrichment-workflows/{workflowId}"},{"label":"Get enrichment workflow definition history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrichment-workflows/getworkflowdefinitionshistory","routeSlug":"/openapi/enrichment-workflows/getworkflowdefinitionshistory","metadata":{"seo":{"title":"Get enrichment workflow definition history","description":"Get enrichment workflow definition history"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowDefinitionsHistory","name":"Get enrichment workflow definition history","isWebhook":false,"pointer":"/paths/~1enrichment-workflows~1{workflowId}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get enrichment workflow definition history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["enrichment-workflows.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_46","description":"ID of the workflow to read history for","required":true}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}~1history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_45","description":"A zero-based offset of the first item in the data collection to return."},{"name":"limit","in":"query","schemaId":"schema_7","description":"Limit the amount of items returned. Values above the maximum are capped."}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enrichment-workflows/{workflowId}/history","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_45"},{"name":"limit","in":"query","required":false,"schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["enrichment-workflows.read"]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/enrichment-workflows/{workflowId}/history","href":"enrichment-workflows/getworkflowdefinitionshistory","openApiOperationId":"getWorkflowDefinitionsHistory","summary":"Get enrichment workflow definition history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionsListResponse"}},"schemaId":"components/schemas/WorkflowDefinitionsListResponse"},{"code":"400","description":"The request was malformed or contained invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"401","description":"Unauthorized - missing or invalid bearer token"},{"code":"403","description":"Forbidden - bearer token lacks the required scope or target company access"},{"code":"404","description":"Workflow definition not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}},"schemaId":"components/schemas/Problem1"},{"code":"429","description":"Rate limit exceeded","headers":{"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-remaining":{"$ref":"#/components/headers/x-ratelimit-remaining"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_0"}],"pointer":"/paths/~1enrichment-workflows~1{workflowId}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinitionsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinitionsListResponse"}}},{"code":"400","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Problem1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem1"}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrichment-workflows/getworkflowdefinitionshistory"}],"panels":[]}]},"httpPath":"/enrichment-workflows/{workflowId}/history"}],"content":{"contentType":"group","meta":{"name":"Enrichment workflows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrichment workflows","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enrichment-workflows","summary":"Get all enrichment workflow definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enrichment-workflows/getallworkflowdefinitions","deprecated":false},{"title":"/enrichment-workflows","summary":"Create enrichment workflow definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrichment-workflows/createworkflowdefinition","deprecated":false},{"title":"/enrichment-workflows/{workflowId}","summary":"Get enrichment workflow definition by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enrichment-workflows/getworkflowdefinition","deprecated":false},{"title":"/enrichment-workflows/{workflowId}","summary":"Update existing enrichment workflow definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/enrichment-workflows/updateworkflowdefinition","deprecated":false},{"title":"/enrichment-workflows/{workflowId}","summary":"Delete enrichment workflow definition by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrichment-workflows/deleteworkflowdefinition","deprecated":false},{"title":"/enrichment-workflows/{workflowId}/history","summary":"Get enrichment workflow definition history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enrichment-workflows/getworkflowdefinitionshistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/openapi/users","routeSlug":"/openapi/users","items":[{"label":"Retrieve user information by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/usersgetbyid","routeSlug":"/openapi/users/usersgetbyid","metadata":{"seo":{"title":"Retrieve user information by id","description":"Retrieve user information by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"usersGetById","name":"Retrieve user information by id","isWebhook":false,"pointer":"/paths/~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve user information by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["users.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","required":true,"example":"6295dcd39db1ab740c3e296c"}],"pointer":"/paths/~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6295dcd39db1ab740c3e296c","schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/users/{id}","href":"users/usersgetbyid","openApiOperationId":"usersGetById","summary":"Retrieve user information by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users~1{id}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/usersgetbyid"}],"panels":[]}]},"httpPath":"/users/{id}"},{"label":"Retrieve a users list for given search criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/userslist","routeSlug":"/openapi/users/userslist","metadata":{"seo":{"title":"Retrieve a users list for given search criteria","description":"Retrieve a users list for given search criteria"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"usersList","name":"Retrieve a users list for given search criteria","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a users list for given search criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["users.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_48"},{"name":"active","in":"query","schemaId":"schema_49"},{"name":"roles","in":"query","schemaId":"schema_50"},{"name":"limit","in":"query","schemaId":"schema_43"},{"name":"offset","in":"query","schemaId":"schema_44"}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_48"},{"name":"active","in":"query","required":false,"schemaId":"schema_49"},{"name":"roles","in":"query","required":false,"schemaId":"schema_50"},{"name":"limit","in":"query","required":false,"schemaId":"schema_43"},{"name":"offset","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/users","href":"users/userslist","openApiOperationId":"usersList","summary":"Retrieve a users list for given search criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}},"schemaId":"components/schemas/UserListResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1users/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/userslist"}],"panels":[]}]},"httpPath":"/users"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{id}","summary":"Retrieve user information by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/usersgetbyid","deprecated":false},{"title":"/users","summary":"Retrieve a users list for given search criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/userslist","deprecated":false}]}]}]}]}},{"type":"group","label":"Processing Modes","link":"/openapi/processing-modes","routeSlug":"/openapi/processing-modes","items":[{"label":"Retrieve available processing modes list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/processing-modes/processingmodeslist","routeSlug":"/openapi/processing-modes/processingmodeslist","metadata":{"seo":{"title":"Retrieve available processing modes list","description":"Retrieve available processing modes list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processingModesList","name":"Retrieve available processing modes list","isWebhook":false,"pointer":"/paths/~1processing-modes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve available processing modes list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["processing-modes.read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_51"},{"name":"offset","in":"query","schemaId":"schema_44"}],"pointer":"/paths/~1processing-modes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/processing-modes","servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_51"},{"name":"offset","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}}],"scopes":["processing-modes.read"]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/processing-modes","href":"processing-modes/processingmodeslist","openApiOperationId":"processingModesList","summary":"Retrieve available processing modes list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessingModeListResponse"}},"schemaId":"components/schemas/ProcessingModeListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/404/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1"}},"schemaId":"components/schemas/APIErrorResponse1"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1processing-modes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProcessingModeListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessingModeListResponse"}}},{"code":"400","schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/APIErrorResponse1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1"}}},{"code":"500","schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse1","exampleIds":["paths/~1processing-modes/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processing-modes/processingmodeslist"}],"panels":[]}]},"httpPath":"/processing-modes"}],"content":{"contentType":"group","meta":{"name":"Processing Modes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processing Modes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/processing-modes","summary":"Retrieve available processing modes list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processing-modes/processingmodeslist","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccessTokenRequest":{"id":"components/schemas/AccessTokenRequest","kind":"json-schema","title":"AccessTokenRequest","data":{"type":"object","required":["grant_type"],"properties":{"grant_type":{"type":"string","enum":["client_credentials"]}}}},"components/schemas/AccessTokenResponse":{"id":"components/schemas/AccessTokenResponse","kind":"json-schema","title":"AccessTokenResponse","data":{"type":"object","required":["access_token","token_type","expires_in"],"properties":{"access_token":{"type":"string","description":"The access token issued by the authorization server","example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"expires_in":{"type":"integer","description":"The lifetime of the access token in seconds","example":3600},"token_type":{"type":"string","enum":["Bearer"]},"scope":{"type":"string","description":"Scopes allowed for the client","example":"documents.write projects.write"}}}},"components/schemas/BinaryFile":{"id":"components/schemas/BinaryFile","kind":"json-schema","title":"BinaryFile","data":{"type":"string","format":"binary"}},"components/schemas/UploadResponse":{"id":"components/schemas/UploadResponse","kind":"json-schema","title":"UploadResponse","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"6040dc9680b782b365ea77d5"}}}},"components/schemas/DocumentsUpdateExternalDataRequest":{"id":"components/schemas/DocumentsUpdateExternalDataRequest","kind":"json-schema","title":"DocumentsUpdateExternalDataRequest","data":{"type":"object","description":"External data to be associated with the document. The data are provided as a flat JSON object. The properties of that object are case-insensitive. The maximum amount of properties is limited to 20.","properties":{"key1":{"type":"string","example":"value1"},"key2":{"type":"string","example":"value2"}}}},"components/schemas/DocumentsUpdateExternalIdRequest":{"id":"components/schemas/DocumentsUpdateExternalIdRequest","kind":"json-schema","title":"DocumentsUpdateExternalIdRequest","data":{"type":"string","description":"External ID","example":"15b884b0-d551-4865-bda9-4168800c9d87"}},"components/schemas/DocumentsUpdateTitleRequest":{"id":"components/schemas/DocumentsUpdateTitleRequest","kind":"json-schema","title":"DocumentsUpdateTitleRequest","data":{"type":"string","description":"New Title","example":"New Title of Document","maxLength":256}},"components/schemas/DocumentsUpdateTransferRequest":{"id":"components/schemas/DocumentsUpdateTransferRequest","kind":"json-schema","title":"DocumentsUpdateTransferRequest","data":{"type":"object","required":["successful"],"properties":{"successful":{"type":"boolean","description":"Indicates if the transfer was successful or not","example":true},"message":{"type":"string","description":"May be used to provide additional details about the transfer. Especially in the erroneous case this field is valueable."}}}},"components/schemas/DocumentsUpdateRejectionRequest":{"id":"components/schemas/DocumentsUpdateRejectionRequest","kind":"json-schema","title":"DocumentsUpdateRejectionRequest","data":{"type":"object","properties":{"message":{"type":"string","description":"May be used to provide additional details about the rejection."}}}},"components/schemas/DocumentsListResponse":{"id":"components/schemas/DocumentsListResponse","kind":"json-schema","title":"DocumentsListResponse","data":{"type":"object","required":["documents"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResponse"}},"limit":{"type":"integer","description":"The limit used for this page of results. This will be the same as the limit query parameter unless it exceeds the maximal allowed value.","example":20},"offset":{"type":"integer","description":"The offset used for this page of results. This will be the same as the offset query parameter","example":0},"totalCount":{"type":"integer","description":"The total number of elements in the data attribute","example":1000}}}},"components/schemas/DocumentResponse":{"id":"components/schemas/DocumentResponse","kind":"json-schema","title":"DocumentResponse","data":{"type":"object","required":["id","createdAt","createdBy","state","title"],"properties":{"id":{"type":"string","example":"6040dc9680b782b365ea77d5"},"completedAt":{"type":"string","format":"date-time","example":"1990-12-31T15:59:60-08:00"},"completedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time","example":"1990-12-31T15:59:60-08:00"},"createdBy":{"type":"string"},"fileId":{"type":"string","description":"Identifier of the primary file associated with this document.","example":"5349b4ddd2781d08c09890f4"},"caseId":{"type":"string","nullable":true,"example":"5349b4ddd1111d08c09890f4"},"files":{"type":"array","nullable":true,"description":"List of files associated with this document, each with their assigned role and main file flag.","items":{"$ref":"#/components/schemas/DocumentFile"},"example":[{"id":"5349b4ddd2781d08c09890f4","type":"salesOrder","mainFile":true},{"id":"5349b4ddd2781d08c09890f5","type":"supportingDocument","mainFile":false}]},"previewFileId":{"type":"string","nullable":true,"description":"Identifier of the preview file for this document, if available.","example":"5349b4ddd2781d08c09890f6"},"entities":{"type":"object","example":{"currency":"EUR","items":[{"name":"High quality cement for rabbit hole sealing","qty":1}],"number":"2018-DE-0011122351","qty":2}},"externalId":{"type":"string","example":"doc-0001"},"externalData":{"type":"object","example":{"internalSystemId":"sap-01"}},"projectId":{"type":"string","example":"6040dc9680b782b365ea77d5"},"state":{"$ref":"#/components/schemas/DocumentState"},"title":{"type":"string","example":"scan-doc-1.jpg"},"updatedAt":{"type":"string","format":"date-time","example":"1990-12-31T15:59:60-08:00"},"updatedBy":{"type":"string"},"url":{"type":"string","example":"https://example.com/documents/6040dc9680b782b365ea77d5","description":"URL to access the document"}}}},"components/schemas/DocumentFile":{"id":"components/schemas/DocumentFile","kind":"json-schema","title":"DocumentFile","data":{"type":"object","required":["id","type","mainFile"],"properties":{"id":{"type":"string","description":"Identifier of the file as returned by the upload endpoint.","example":"5349b4ddd2781d08c09890f4"},"type":{"type":"string","nullable":true,"description":"The role the file plays in the document (e.g. salesOrder, attachment). Must only contain letters from the Latin alphabet with no whitespace or special characters.","pattern":"^[a-zA-Z]+$","example":"salesOrder"},"mainFile":{"type":"boolean","nullable":true,"description":"Indicates whether this file is the main file of the document.","example":true}}}},"components/schemas/DocumentState":{"id":"components/schemas/DocumentState","kind":"json-schema","title":"DocumentState","data":{"type":"string","enum":["done","doneAutomatically","extracted","failed","inCompletion","junk","new","processing","rejected","reviewRequired","split","transferFailed","transferred"]}},"components/schemas/DocumentStatesResponse":{"id":"components/schemas/DocumentStatesResponse","kind":"json-schema","title":"DocumentStatesResponse","data":{"type":"array","items":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/DocumentState"},"updatedAt":{"type":"string","format":"date-time","example":"1990-12-31T15:59:60-08:00"}}}}},"components/schemas/ProcessFileRequest":{"id":"components/schemas/ProcessFileRequest","kind":"json-schema","title":"ProcessFileRequest","data":{"type":"object","required":["fileId","projectId"],"properties":{"fileId":{"type":"string","example":"5349b4ddd2781d08c09890f4"},"projectId":{"type":"string","example":"00000020f51bb4362eee2a4d"},"externalId":{"type":"string","description":"External id of the file. Can be used if you want to link the file with an identifier in your system.","example":"doc-0001"},"externalData":{"$ref":"#/components/schemas/DocumentsUpdateExternalDataRequest"}}}},"components/schemas/ProcessingAccepted":{"id":"components/schemas/ProcessingAccepted","kind":"json-schema","title":"ProcessingAccepted","data":{"type":"object","required":["documentId","fileId","projectId"],"properties":{"documentId":{"type":"string","example":"6040dc9680b782b365ea77d5"},"fileId":{"type":"string","example":"5349b4ddd2781d08c09890f4"},"projectId":{"type":"string","example":"00000020f51bb4362eee2a4d"}}}},"components/schemas/ProcessFileBatchRequest":{"id":"components/schemas/ProcessFileBatchRequest","kind":"json-schema","title":"ProcessFileBatchRequest","data":{"type":"object","required":["fileIds","projectId"],"properties":{"caseRoutingKey":{"type":"string","description":"Routing context applied to every classified case in this batch.","example":"DE"},"fileIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"minItems":1,"description":"List of file identifiers to be processed as a batch into cases.","example":["375514e5-dac7-4b8d-963f-7f7b9e6d3d04","96844098-0059-4664-95b8-c4c072aa94e3"]},"projectId":{"type":"string","description":"Identifier of the project in which the cases will be created.","example":"69bbd0546290cc2162b433de"},"externalId":{"type":"string","description":"External identifier of the file batch. Can be used to link the batch with an identifier in your system. Will be propagated to all cases created from this batch.","example":"batch-0001"},"externalData":{"$ref":"#/components/schemas/ExternalData"}}}},"components/schemas/ProcessFileBatchAccepted":{"id":"components/schemas/ProcessFileBatchAccepted","kind":"json-schema","title":"ProcessFileBatchAccepted","data":{"type":"object","required":["fileBatchId","fileIds","projectId"],"properties":{"fileBatchId":{"type":"string","description":"Identifier of the file batch. Can be used to retrieve the cases created from this batch via GET /cases once processing is complete.","example":"0e99a5b2-9010-4e86-a906-19c45e903fe8"},"fileIds":{"type":"array","items":{"type":"string"},"description":"List of file identifiers that are part of this batch.","example":["2a77b5c8-30de-4e35-b078-3bba981cf80c","2c6fe52d-26c0-4a7a-80a9-97d497b1a078"]},"projectId":{"type":"string","description":"Identifier of the project in which the cases will be created.","example":"69bbd1d72f6eb584a70e79f0"}}}},"components/schemas/CreateCaseRequest":{"id":"components/schemas/CreateCaseRequest","kind":"json-schema","title":"CreateCaseRequest","data":{"type":"object","required":["files","projectId"],"properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/CaseFile"},"minItems":1,"description":"List of files to include in the case, each with their assigned role."},"projectId":{"type":"string","description":"Identifier of the project in which the case will be created.","example":"69bbd1e18cab258833c9ecf8"},"externalId":{"type":"string","description":"External identifier of the case. Can be used to link the case with an identifier in your system.","example":"case-0001"},"externalData":{"$ref":"#/components/schemas/ExternalData"}}}},"components/schemas/CaseFile":{"id":"components/schemas/CaseFile","kind":"json-schema","title":"CaseFile","data":{"type":"object","required":["id","type","mainFile"],"properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Identifier of the file as returned by the upload endpoint.","example":"197c997c-4bab-41e7-b33d-bad287046914"},"type":{"type":"string","description":"The role the file plays in the case (e.g. mainDocument, attachment). Must only contain letters from the Latin alphabet with no whitespace or special characters.","pattern":"^[a-zA-Z]+$","example":"salesOrder"},"mainFile":{"type":"boolean","description":"Indicates whether this file is the main document of the case.","example":true},"passthroughArtifact":{"type":"boolean","default":false,"description":"Retain this file for download/export without content processing or document previews. Applies independently of the file role and MIME type. Omission preserves normal processing.","example":true}}}},"components/schemas/CreateCaseAccepted":{"id":"components/schemas/CreateCaseAccepted","kind":"json-schema","title":"CreateCaseAccepted","data":{"type":"object","required":["caseId","projectId"],"properties":{"caseId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the case being created. Can be used to retrieve the case via GET /cases/{id} once processing is complete."},"children":[]}]}]}],"example":"8512a5dd-91b9-4363-a869-db17394a955d"},"projectId":{"type":"string","description":"Identifier of the project in which the case is being created.","example":"69bbd20e5c155a70e763bc8d"}}}},"components/schemas/CasesListResponse":{"id":"components/schemas/CasesListResponse","kind":"json-schema","title":"CasesListResponse","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponse"}},"limit":{"type":"integer","description":"The limit used for this page of results. This will be the same as the limit query parameter unless it exceeds the maximum allowed value.","example":20},"offset":{"type":"integer","description":"The offset used for this page of results. This will be the same as the offset query parameter.","example":0},"totalCount":{"type":"integer","description":"The total number of elements in the data attribute.","example":1000}}}},"components/schemas/CaseResponse":{"id":"components/schemas/CaseResponse","kind":"json-schema","title":"CaseResponse","data":{"type":"object","required":["id","createdAt","createdBy","state","files","projectId"],"properties":{"id":{"type":"string","example":"69c5a545-7b2f-4f4a-833b-45feff1056c7"},"createdAt":{"type":"string","format":"date-time","example":"2020-01-01T15:00:00Z"},"createdBy":{"type":"string"},"completedAt":{"type":"string","format":"date-time","example":"2020-01-01T15:00:00Z"},"completedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time","example":"2020-01-01T15:00:00Z"},"updatedBy":{"type":"string"},"transferSuccessful":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the case was transferred successfully to the target system. Will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the transfer status is not yet known (e.g. because the case is still being processed or the transfer information has not been provided yet)."},"children":[]}]}]}],"example":true},"transferMessage":{"type":"string","description":"May contain additional information about the transfer, especially in the case of a failed transfer.","example":"Upload failed due to ERP being down"},"files":{"type":"array","items":{"$ref":"#/components/schemas/CaseFile"},"description":"List of files that are part of the case, each with their assigned role and main document flag."},"entities":{"type":"object","description":"Entities extracted from the case by the AI Agents.","example":{"currency":"EUR","items":[{"name":"High quality cement for rabbit hole sealing","qty":1}],"number":"2018-DE-0011122351","qty":2}},"externalId":{"type":"string","example":"case-0001"},"externalData":{"type":"object","example":{"internalSystemId":"sap-01"}},"projectId":{"type":"string","example":"69bbd22c92f3c3ee4a097784"},"fileBatchId":{"type":"string","description":"Identifier of the file batch this case was created from. Only present for cases created via POST /cases/process-file-batch.","example":"a1b0020b-8ef9-4801-aeef-979224af0bab"},"previewFileId":{"type":"string","description":"Identifier of the file used as the case preview, if any.","example":"197c997c-4bab-41e7-b33d-bad287046914"},"state":{"$ref":"#/components/schemas/CaseState"},"url":{"type":"string","example":"https://example.com/cases/6040dc9680b782b365ea77d5","description":"URL to access the case."}}}},"components/schemas/CaseState":{"id":"components/schemas/CaseState","kind":"json-schema","title":"CaseState","data":{"type":"string","enum":["done","doneAutomatically","failed","inCompletion","new","processing","rejected","reviewRequired","transferFailed","transferred"]}},"components/schemas/CasesUpdateTransferRequest":{"id":"components/schemas/CasesUpdateTransferRequest","kind":"json-schema","title":"CasesUpdateTransferRequest","data":{"type":"object","required":["successful"],"properties":{"successful":{"type":"boolean","description":"Indicates if the transfer was successful or not.","example":true},"message":{"type":"string","description":"May be used to provide additional details about the transfer. Especially valuable in the erroneous case."}}}},"components/schemas/ExternalData":{"id":"components/schemas/ExternalData","kind":"json-schema","title":"ExternalData","data":{"type":"object","description":"Associated external data. Will be applied to the case or to all cases in a batch.\nProvided as a flat JSON object. The properties are case-insensitive.\nThe maximum amount of properties is limited to 20.\n","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true}]}}},"components/schemas/validationError":{"id":"components/schemas/validationError","kind":"json-schema","title":"validationError","data":{"required":["loc","msg","type"],"type":"object","properties":{"loc":{"type":"array","items":{"type":"string"}},"msg":{"type":"string"},"type":{"type":"string"}}}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/validationError"}}}}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.\n","default":"about:blank","example":"/some/uri-reference"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n","example":"some title for the error situation"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.\n","minimum":100,"maximum":599},"detail":{"type":"string","description":"A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n","example":"some description for the error situation"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.\n","example":"/some/uri-reference#specific-occurrence-context"}}}},"components/schemas/CompaniesId":{"id":"components/schemas/CompaniesId","kind":"json-schema","title":"CompaniesId","data":{"title":"CompaniesId","type":"string","example":"63e6663823b4c1f5287398bb"}},"components/schemas/CompaniesListResponse":{"id":"components/schemas/CompaniesListResponse","kind":"json-schema","title":"CompaniesListResponse","data":{"title":"CompaniesListResponse","required":["data","limit","offset","totalCount"],"type":"object","properties":{"data":{"title":"Companies list","type":"array","items":{"$ref":"#/components/schemas/CompaniesResponse"}},"limit":{"title":"The limit used for this page of results. This will be the same as the limit query parameter unless it exceeds the maximal allowed value.","type":"integer","example":20},"offset":{"title":"The offset used for this page of results. This will be the same as the offset query parameter.","type":"integer","example":0},"totalCount":{"title":"The total number of elements of the data attribute.","type":"integer","example":1000}}}},"components/schemas/CompaniesResponse":{"id":"components/schemas/CompaniesResponse","kind":"json-schema","title":"CompaniesResponse","data":{"title":"CompaniesResponse","required":["name","id","active","createdAt"],"type":"object","properties":{"name":{"title":"Companies display name","type":"string","example":"Companies Name Inc."},"id":{"title":"Companies identifier","type":"string","example":"63e6663823b4c1f5287398bb"},"active":{"title":"Companies activity flag","type":"boolean","example":true},"createdAt":{"title":"Companies creation date","type":"string","example":"1990-12-31T15:46:19.384990Z"}}}},"components/schemas/ProjectResponse":{"id":"components/schemas/ProjectResponse","kind":"json-schema","title":"ProjectResponse","data":{"type":"object","description":"Project response","required":["id","name","ocr","extractionModelId","createdAt","createdBy","updatedAt","updatedBy","completion","duplicates","members","isLive","generateWordRegionsOnReview","projectType"],"properties":{"id":{"$ref":"#/components/schemas/ProjectId"},"projectType":{"$ref":"#/components/schemas/ProjectType"},"createdAt":{"type":"string","format":"date-time","example":"1990-12-31T15:46:19.384990Z"},"createdBy":{"$ref":"#/components/schemas/ProjectMemberId"},"updatedAt":{"type":"string","format":"date-time","example":"1990-12-31T15:46:19.384990Z"},"updatedBy":{"$ref":"#/components/schemas/ProjectMemberId"},"name":{"$ref":"#/components/schemas/ProjectName"},"note":{"$ref":"#/components/schemas/ProjectNote"},"extractionModelId":{"$ref":"#/components/schemas/ProjectExtractionModelId"},"ocr":{"$ref":"#/components/schemas/ProjectOCRResponse"},"completion":{"$ref":"#/components/schemas/ProjectCompletion"},"duplicates":{"$ref":"#/components/schemas/ProjectDuplicates"},"members":{"oneOf":[{"$ref":"#/components/schemas/ProjectAllMembers"},{"$ref":"#/components/schemas/ProjectMembers"}],"discriminator":{"propertyName":"allow","mapping":{"all":"#/components/schemas/ProjectAllMembers","members":"#/components/schemas/ProjectMembers"}}},"retentionDays":{"$ref":"#/components/schemas/ProjectRetentionDays"},"isLive":{"$ref":"#/components/schemas/ProjectIsLive"},"generateWordRegionsOnReview":{"$ref":"#/components/schemas/ProjectGenerateWordRegionsOnReview"}}}},"components/schemas/ProjectId":{"id":"components/schemas/ProjectId","kind":"json-schema","title":"ProjectId","data":{"title":"ProjectId","description":"Project ID","type":"string","example":"63e6663823b4c1f5287398bb"}},"components/schemas/ProjectType":{"id":"components/schemas/ProjectType","kind":"json-schema","title":"ProjectType","data":{"title":"ProjectType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project processing type. Set on creation and immutable afterwards."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - classic extraction project backed by an extraction model"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - pre-processing project backed by the company's Cases processing mode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - execution project backed by the company's Cases processing mode"},"children":[]}]}]}]}],"type":"string","enum":["documentProcessing","preProcessing","execution"],"example":"documentProcessing","default":"documentProcessing"}},"components/schemas/ProjectName":{"id":"components/schemas/ProjectName","kind":"json-schema","title":"ProjectName","data":{"description":"Project name","type":"string","example":"My Project","minLength":1,"maxLength":60}},"components/schemas/ProjectNote":{"id":"components/schemas/ProjectNote","kind":"json-schema","title":"ProjectNote","data":{"description":"Project note","type":"string","example":"My project description note","minLength":1,"maxLength":1000}},"components/schemas/ProjectExtractionModelId":{"id":"components/schemas/ProjectExtractionModelId","kind":"json-schema","title":"ProjectExtractionModelId","data":{"title":"ProjectExtractionModelId","description":"Extraction Model id","type":"string","example":"63e6663823b4c1f5287398bb"}},"components/schemas/ProjectOCRRequest":{"id":"components/schemas/ProjectOCRRequest","kind":"json-schema","title":"ProjectOCRRequest","data":{"title":"ProjectOCRRequest","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OCR configuration accepted when creating or updating a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" engines can be set. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abbyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chinese"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"engines are returned by read endpoints for existing projects but are rejected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent in a request."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ProjectOCRGoogle"},{"$ref":"#/components/schemas/ProjectOCRInternal"}],"discriminator":{"propertyName":"engine","mapping":{"google":"#/components/schemas/ProjectOCRGoogle","internal":"#/components/schemas/ProjectOCRInternal"}}}},"components/schemas/ProjectOCRResponse":{"id":"components/schemas/ProjectOCRResponse","kind":"json-schema","title":"ProjectOCRResponse","data":{"title":"ProjectOCRResponse","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OCR configuration returned for a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Covers every engine a project may currently be configured with, including the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read-only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abbyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chinese"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" engines."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ProjectOCRAbbyy"},{"$ref":"#/components/schemas/ProjectOCRGoogle"},{"$ref":"#/components/schemas/ProjectOCRChinese"},{"$ref":"#/components/schemas/ProjectOCRInternal"}],"discriminator":{"propertyName":"engine","mapping":{"abbyy":"#/components/schemas/ProjectOCRAbbyy","google":"#/components/schemas/ProjectOCRGoogle","chinese":"#/components/schemas/ProjectOCRChinese","internal":"#/components/schemas/ProjectOCRInternal"}}}},"components/schemas/ProjectOCRAbbyy":{"id":"components/schemas/ProjectOCRAbbyy","kind":"json-schema","title":"ProjectOCRAbbyy","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Abbyy OCR configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only: returned for existing projects, but rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a create or update request."},"children":[]}]}]}],"required":["engine","features","languages"],"properties":{"engine":{"type":"string","enum":["abbyy"]},"features":{"type":"array","items":{"$ref":"#/components/schemas/ProjectOCRAbbyyFeatures"}},"languages":{"$ref":"#/components/schemas/ProjectOCRAbbyyLanguages"}}}},"components/schemas/ProjectOCRAbbyyFeatures":{"id":"components/schemas/ProjectOCRAbbyyFeatures","kind":"json-schema","title":"ProjectOCRAbbyyFeatures","data":{"type":"string","enum":["barcodes"]}},"components/schemas/ProjectOCRAbbyyLanguages":{"id":"components/schemas/ProjectOCRAbbyyLanguages","kind":"json-schema","title":"ProjectOCRAbbyyLanguages","data":{"type":"array","description":"Array of abbyy ocr languages used within a project","maxItems":5,"minItems":1,"items":{"$ref":"#/components/schemas/ProjectOCRAbbyyLanguage"},"example":["German","English"]}},"components/schemas/ProjectOCRAbbyyLanguage":{"id":"components/schemas/ProjectOCRAbbyyLanguage","kind":"json-schema","title":"ProjectOCRAbbyyLanguage","data":{"type":"string","description":"Abbyy ocr supported languages","enum":["Arabic","ArmenianEastern","ArmenianGrabar","ArmenianWestern","Bulgarian","Catalan","ChinesePRC","ChineseTaiwan","Croatian","Czech","Danish","Dutch","DutchBelgian","English","Estonian","Farsi","Finnish","French","German","Greek","Hebrew","Hungarian","Icelandic","Indonesian","Irish","Italian","Japanese","Korean","KoreanHangul","Latin","Latvian","Lithuanian","Macedonian","Malay","Norwegian","Polish","PortugueseBrazilian","PortugueseStandard","Romanian","Russian","SerbianCyrillic","SerbianLatin","Slovenian","Spanish","Swedish","Thai","Turkish","UighurCyrillic","UighurLatin","Ukrainian","Vietnamese","Welsh"]}},"components/schemas/ProjectOCRGoogle":{"id":"components/schemas/ProjectOCRGoogle","kind":"json-schema","title":"ProjectOCRGoogle","data":{"type":"object","description":"Google OCR configuration","required":["engine","features"],"properties":{"engine":{"type":"string","enum":["google"]},"features":{"type":"array","items":{"$ref":"#/components/schemas/ProjectOCRGoogleFeatures"}}}}},"components/schemas/ProjectOCRGoogleFeatures":{"id":"components/schemas/ProjectOCRGoogleFeatures","kind":"json-schema","title":"ProjectOCRGoogleFeatures","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google OCR features"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"barcodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Detect barcodes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalProcessingForBarcodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Additional barcode processing that can improve detection; resource heavy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disableBoxFilter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Disable the bounding box filter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plainText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Plain text OCR"},"children":[]}]}]}]}],"enum":["barcodes","additionalProcessingForBarcodes","disableBoxFilter","plainText"]}},"components/schemas/ProjectOCRInternal":{"id":"components/schemas/ProjectOCRInternal","kind":"json-schema","title":"ProjectOCRInternal","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal OCR configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal engine takes no features and no languages. It does not produce word"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"positions; enable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generateWordRegionsOnReview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get word bounding boxes for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documents that require review."},"children":[]}]}]}],"required":["engine"],"properties":{"engine":{"type":"string","enum":["internal"]}}}},"components/schemas/ProjectOCRChinese":{"id":"components/schemas/ProjectOCRChinese","kind":"json-schema","title":"ProjectOCRChinese","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chinese OCR configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only: returned for existing projects, but rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a create or update request. The chinese engine takes no features and no languages."},"children":[]}]}]}],"required":["engine"],"properties":{"engine":{"type":"string","enum":["chinese"]}}}},"components/schemas/ProjectCompletion":{"id":"components/schemas/ProjectCompletion","kind":"json-schema","title":"ProjectCompletion","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProjectCompletion type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mark documents as completed after succesfull validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mark documents to review after succesfull validation"},"children":[]}]}]}]}],"enum":["automatic","manual"],"example":"manual","default":"manual"}},"components/schemas/ProjectDuplicates":{"id":"components/schemas/ProjectDuplicates","kind":"json-schema","title":"ProjectDuplicates","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How duplicates documents show be handle"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Allow documents duplicates to be processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mark documents duplicates as failed"},"children":[]}]}]}]}],"enum":["allow","fail"],"example":"allow","default":"fail"}},"components/schemas/ProjectAllMembers":{"id":"components/schemas/ProjectAllMembers","kind":"json-schema","title":"ProjectAllMembers","data":{"title":"ProjectAllMembers","description":"Allow all users to access a project","type":"object","properties":{"allow":{"type":"string","enum":["all"]}}}},"components/schemas/ProjectMembers":{"id":"components/schemas/ProjectMembers","kind":"json-schema","title":"ProjectMembers","data":{"title":"ProjectMembers","description":"Allow provided members to access project","type":"object","properties":{"allow":{"type":"string","enum":["members"]},"members":{"type":"array","items":{"$ref":"#/components/schemas/ProjectMemberId"}}}}},"components/schemas/ProjectMemberId":{"id":"components/schemas/ProjectMemberId","kind":"json-schema","title":"ProjectMemberId","data":{"description":"Project member id","type":"string","example":"63e6663823b4c1f5287398bb"}},"components/schemas/ProjectRetentionDays":{"id":"components/schemas/ProjectRetentionDays","kind":"json-schema","title":"ProjectRetentionDays","data":{"description":"Project document retention in days","type":"integer","example":180,"minimum":1,"maximum":3650}},"components/schemas/ProjectIsLive":{"id":"components/schemas/ProjectIsLive","kind":"json-schema","title":"ProjectIsLive","data":{"description":"Indicates if a project is live or not","type":"boolean","default":false}},"components/schemas/ProjectGenerateWordRegionsOnReview":{"id":"components/schemas/ProjectGenerateWordRegionsOnReview","kind":"json-schema","title":"ProjectGenerateWordRegionsOnReview","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate word bounding boxes for documents that require human review."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled, documents that stop for review ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extracted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") get an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional OCR pass that produces word regions, unless the project's OCR engine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already provided them. Useful for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OCR engine, which does not place words."},"children":[]}]}]}],"type":"boolean","default":false,"example":true}},"components/schemas/ProjectCreateRequest":{"id":"components/schemas/ProjectCreateRequest","kind":"json-schema","title":"ProjectCreateRequest","data":{"type":"object","required":["name","ocr","completion","duplicates","members","schema"],"properties":{"name":{"$ref":"#/components/schemas/ProjectName"},"note":{"$ref":"#/components/schemas/ProjectNote"},"projectType":{"$ref":"#/components/schemas/ProjectType"},"ocr":{"$ref":"#/components/schemas/ProjectOCRRequest"},"extractionModelId":{"type":"string","nullable":true,"example":"63e6663823b4c1f5287398bb","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing mode used by the project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to select the default processing mode for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an explicit value must match the company's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically selected Cases processing mode; the Cases processing mode cannot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" projects. Malformed or mismatched IDs return"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; invalid or unknown document-processing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"model IDs, or a missing company default, return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"completion":{"$ref":"#/components/schemas/ProjectCompletion"},"duplicates":{"$ref":"#/components/schemas/ProjectDuplicates"},"members":{"oneOf":[{"$ref":"#/components/schemas/ProjectAllMembers"},{"$ref":"#/components/schemas/ProjectMembers"}],"discriminator":{"propertyName":"allow","mapping":{"all":"#/components/schemas/ProjectAllMembers","members":"#/components/schemas/ProjectMembers"}}},"schema":{"$ref":"#/components/schemas/Schema"},"retentionDays":{"allOf":[{"$ref":"#/components/schemas/ProjectRetentionDays"},{"default":180}]},"isLive":{"$ref":"#/components/schemas/ProjectIsLive"},"generateWordRegionsOnReview":{"$ref":"#/components/schemas/ProjectGenerateWordRegionsOnReview"}}}},"components/schemas/ProjectUpdateRequest":{"id":"components/schemas/ProjectUpdateRequest","kind":"json-schema","title":"ProjectUpdateRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for partial project update (PATCH). All fields are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields not included in the request will remain unchanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields explicitly set to null will clear the value (only for clearable fields: note, retentionDays)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other fields (name, extractionModelId, ocr, completion, duplicates, isLive, generateWordRegionsOnReview, members, schema) may be omitted but cannot be set to null; sending null returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one field must be provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is immutable and cannot be updated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" projects, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extractionModelId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company's automatically selected Cases processing mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OCR engines can be set. To update a project that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currently uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abbyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chinese"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", omit the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ocr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/ProjectName"},"note":{"allOf":[{"$ref":"#/components/schemas/ProjectNote"}]},"ocr":{"$ref":"#/components/schemas/ProjectOCRRequest"},"extractionModelId":{"$ref":"#/components/schemas/ProjectExtractionModelId"},"completion":{"$ref":"#/components/schemas/ProjectCompletion"},"duplicates":{"$ref":"#/components/schemas/ProjectDuplicates"},"retentionDays":{"allOf":[{"$ref":"#/components/schemas/ProjectRetentionDays"}]},"isLive":{"$ref":"#/components/schemas/ProjectIsLive"},"generateWordRegionsOnReview":{"$ref":"#/components/schemas/ProjectGenerateWordRegionsOnReview"},"members":{"oneOf":[{"$ref":"#/components/schemas/ProjectAllMembers"},{"$ref":"#/components/schemas/ProjectMembers"}],"discriminator":{"propertyName":"allow","mapping":{"all":"#/components/schemas/ProjectAllMembers","members":"#/components/schemas/ProjectMembers"}}},"schema":{"$ref":"#/components/schemas/Schema"}}}},"components/schemas/ProjectListResponse":{"id":"components/schemas/ProjectListResponse","kind":"json-schema","title":"ProjectListResponse","data":{"title":"ProjectListResponse","required":["data","totalCount","limit","offset"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/ProjectResponse"}},"limit":{"title":"limit","type":"integer","example":20},"offset":{"title":"offset","type":"integer","example":0},"totalCount":{"title":"Totalcount","type":"integer","example":1}}}},"components/schemas/Schema":{"id":"components/schemas/Schema","kind":"json-schema","title":"Schema","data":{"title":"Schema","type":"object","properties":{"version":{"title":"Version","type":"integer","example":1},"dataPoints":{"title":"DataPoints","type":"array","items":{"type":"object","properties":{"internalName":{"type":"string"},"displayName":{"type":"string"},"type":{"type":"string"},"normalization":{"type":"array","items":{"type":"object"}},"rules":{"type":"object"}}},"example":[{"internalName":"type","displayName":"Type","type":"string","source":{"type":"extractor"},"normalization":[],"rules":{}},{"internalName":"number","displayName":"Number","type":"string","source":{"type":"extractor"},"normalization":[],"rules":{}},{"internalName":"issuedAt","displayName":"Issued At","type":"date","preferDayOfMonth":"last","source":{"type":"extractor"},"normalization":[],"rules":{}},{"internalName":"deliveredAt","displayName":"Delivered At","type":"date","preferDayOfMonth":"last","source":{"type":"extractor"},"normalization":[],"rules":{}},{"internalName":"currency","displayName":"Currency","type":"string","source":{"type":"extractor"},"normalization":[],"rules":{}}]},"features":{"type":"object","properties":{"derivation":{"type":"boolean","example":false}}},"enrichment":{"type":"object"},"normalization":{"type":"object"},"validation":{"type":"object"}}}},"components/schemas/EmailResponse":{"id":"components/schemas/EmailResponse","kind":"json-schema","title":"EmailResponse","data":{"properties":{"id":{"type":"string","title":"Document id","example":"6040dc9680b782b365ea77d5"},"senderAddresses":{"items":{"type":"string"},"type":"array","title":"Email sender adresses","example":["no-replay@hypatos.com","joe.doe@example.com"]},"subject":{"type":"string","title":"Email subject","example":"Document from this month"}},"type":"object","required":["id","senderAddresses"],"title":"EmailResponse"}},"components/schemas/ConditionEdgesEvaluation":{"id":"components/schemas/ConditionEdgesEvaluation","kind":"json-schema","title":"ConditionEdgesEvaluation","data":{"properties":{"type":{"type":"string","enum":["conditionalEdges"],"title":"Type","default":"conditionalEdges"},"condition":{"$ref":"#/components/schemas/ConditionType"}},"type":"object","required":["condition"],"title":"ConditionEdgesEvaluation"}},"components/schemas/ConditionType":{"id":"components/schemas/ConditionType","kind":"json-schema","title":"ConditionType","data":{"type":"string","enum":["or","and"],"title":"ConditionType","description":"An enumeration."}},"components/schemas/RoutingAction":{"id":"components/schemas/RoutingAction","kind":"json-schema","title":"RoutingAction","data":{"oneOf":[{"$ref":"#/components/schemas/RoutingMoveAction"},{"$ref":"#/components/schemas/RoutingCopyAction"}],"discriminator":{"propertyName":"type","mapping":{"move":"#/components/schemas/RoutingMoveAction","copy":"#/components/schemas/RoutingCopyAction"}},"title":"RoutingAction"}},"components/schemas/PostMoveAction":{"id":"components/schemas/PostMoveAction","kind":"json-schema","title":"PostMoveAction","data":{"type":"string","enum":["none","refresh","reprocess","merge"],"title":"PostMoveAction","default":"reprocess","description":"Defines the action to be executed for the document in the target project."}},"components/schemas/PostCopyAction":{"id":"components/schemas/PostCopyAction","kind":"json-schema","title":"PostCopyAction","data":{"type":"string","enum":["none","reprocess","resetState"],"title":"PostCopyAction","default":"reprocess","description":"Defines the action to be executed for the document in the target project."}},"components/schemas/RoutingMoveAction":{"id":"components/schemas/RoutingMoveAction","kind":"json-schema","title":"RoutingMoveAction","data":{"type":"object","properties":{"type":{"type":"string","enum":["move"],"default":"move","title":"Type"},"postMoveAction":{"$ref":"#/components/schemas/PostMoveAction"}},"required":["type","postMoveAction"],"title":"RoutingMoveAction","example":{"type":"move","postMoveAction":"reprocess"}}},"components/schemas/RoutingCopyAction":{"id":"components/schemas/RoutingCopyAction","kind":"json-schema","title":"RoutingCopyAction","data":{"type":"object","properties":{"type":{"type":"string","enum":["copy"],"default":"copy","title":"Type"},"postCopyAction":{"$ref":"#/components/schemas/PostCopyAction"}},"required":["type","postCopyAction"],"title":"RoutingCopyAction"}},"components/schemas/RoutingRequest":{"id":"components/schemas/RoutingRequest","kind":"json-schema","title":"RoutingRequest","data":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Routing name","example":"Document routing name"},"fromProjectId":{"type":"string","title":"Identifier of a project where routings evaluation will happen","example":"63e6663823b4c1f5287398bb"},"toProjectId":{"type":"string","title":"Identifier of a project where documents will be moved to if routings evaluation passes","example":"63e6663823b4c1f5287398bb"},"postRoutingAction":{"allOf":[{"$ref":"#/components/schemas/PostRoutingAction"}],"title":"Action done after document is routed","default":"reprocess","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routingAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}]},"active":{"type":"boolean","title":"Only active routings will be evaluated","example":true},"routingNode":{"allOf":[{"$ref":"#/components/schemas/RoutingNode"}],"title":"Routing node evaluation definition"},"routingAction":{"$ref":"#/components/schemas/RoutingAction"}},"required":["name","fromProjectId","toProjectId","active","routingNode","routingAction"]}},"components/schemas/CreateRoutingRequest":{"id":"components/schemas/CreateRoutingRequest","kind":"json-schema","title":"CreateRoutingRequest","data":{"allOf":[{"$ref":"#/components/schemas/RoutingRequest"},{"type":"object","properties":{"createdBy":{"type":"string","title":"Routing creator","example":"671f771235cd520084dd655f"}}}],"title":"CreateRoutingRequest"}},"components/schemas/UpdateRoutingRequest":{"id":"components/schemas/UpdateRoutingRequest","kind":"json-schema","title":"UpdateRoutingRequest","data":{"allOf":[{"$ref":"#/components/schemas/RoutingRequest"},{"type":"object","properties":{"modifiedBy":{"type":"string","title":"Routing modifier","example":"671f771235cd520084dd655f"}}}],"title":"UpdateRoutingRequest"}},"components/schemas/DocumentEvaluation":{"id":"components/schemas/DocumentEvaluation","kind":"json-schema","title":"DocumentEvaluation","data":{"properties":{"type":{"type":"string","enum":["document"],"title":"Type","default":"document"},"operator":{"$ref":"#/components/schemas/EvaluationOperator"},"evaluateWithValue":{"title":"Evaluatewithvalue","type":"string"},"evaluateIfMissing":{"type":"boolean","title":"Evaluateifmissing"},"documentPath":{"type":"array","items":{"$ref":"#/components/schemas/Path"}}},"type":"object","required":["operator","documentPath"],"title":"DocumentEvaluation"}},"components/schemas/EvaluationOperator":{"id":"components/schemas/EvaluationOperator","kind":"json-schema","title":"EvaluationOperator","data":{"type":"string","enum":["contains","equal","notEqual","==","!=",">",">=","<","<="],"title":"EvaluationOperator","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Evaluation operators. >, >=, <, <= are used only for numbers. ==/equal, !=/notEqual means same, consider equal/notEqual words as deprecated."},"children":[]}]}]}]}},"components/schemas/OrderDirection":{"id":"components/schemas/OrderDirection","kind":"json-schema","title":"OrderDirection","data":{"type":"string","enum":["up","down"],"title":"OrderDirection","description":"An enumeration."}},"components/schemas/PostRoutingAction":{"id":"components/schemas/PostRoutingAction","kind":"json-schema","title":"PostRoutingAction","data":{"type":"string","enum":["none","refresh","reprocess","merge"],"title":"PostRoutingAction","description":"Defines the action to be executed for the routed document in the target project."}},"components/schemas/RoutingListResponse":{"id":"components/schemas/RoutingListResponse","kind":"json-schema","title":"RoutingListResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RoutingResponse"},"type":"array","title":"Data"},"totalCount":{"type":"integer","title":"Totalcount"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["data","totalCount","limit","offset"],"title":"RoutingListResponse"}},"components/schemas/RoutingNode":{"id":"components/schemas/RoutingNode","kind":"json-schema","title":"RoutingNode","data":{"properties":{"evaluation":{"anyOf":[{"$ref":"#/components/schemas/SchemaEvaluation"},{"$ref":"#/components/schemas/ConditionEdgesEvaluation"},{"$ref":"#/components/schemas/DocumentEvaluation"}],"title":"Evaluation"},"edges":{"items":{"$ref":"#/components/schemas/RoutingNode"},"type":"array","title":"Edges","example":[]}},"type":"object","required":["evaluation"],"title":"RoutingNode"}},"components/schemas/RoutingOrderRequest":{"id":"components/schemas/RoutingOrderRequest","kind":"json-schema","title":"RoutingOrderRequest","data":{"properties":{"direction":{"allOf":[{"$ref":"#/components/schemas/OrderDirection"}],"title":"Moving order direction","example":"down"},"count":{"type":"integer","title":"Moving order count in given direction","example":2}},"type":"object","required":["direction","count"],"title":"RoutingOrderRequest"}},"components/schemas/RoutingResponse":{"id":"components/schemas/RoutingResponse","kind":"json-schema","title":"RoutingResponse","data":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Routing name","example":"Document routing name"},"fromProjectId":{"type":"string","title":"Identifier of a project where routings evaluation will happen","example":"263e6663823b4c1f5287398bb"},"toProjectId":{"type":"string","title":"Identifier of a project where documents will be moved to if routings evaluation passes","example":"263e6663823b4c1f5287398bb"},"postRoutingAction":{"allOf":[{"$ref":"#/components/schemas/PostRoutingAction"}],"title":"Action done after document is routed","default":"reprocess","example":"reprocess"},"active":{"type":"boolean","title":"Only active routings will be evaluated","example":true},"routingNode":{"allOf":[{"$ref":"#/components/schemas/RoutingNode"}],"title":"Routing node evaluation definition"},"id":{"type":"string","title":"Routing identifier","example":"63e6663823b4c1f5287398bb"},"modifiedAt":{"type":"string","title":"Routing last modification date","example":"2023-02-10T15:46:19.384990Z"},"modifiedBy":{"type":"string","title":"Routing last modification by","example":"671f771235cd520084dd655f"},"createdBy":{"type":"string","title":"Routing last creation by","example":"671f771235cd520084dd655f"},"createdAt":{"type":"string","title":"Routing last creation date","example":"2023-02-10T15:46:19.384990Z"},"order":{"type":"integer","title":"Routing order","example":0},"routingAction":{"$ref":"#/components/schemas/RoutingAction"}},"type":"object","required":["name","fromProjectId","toProjectId","active","routingNode","id","order","routingAction"],"title":"RoutingResponse"}},"components/schemas/SchemaEvaluation":{"id":"components/schemas/SchemaEvaluation","kind":"json-schema","title":"SchemaEvaluation","data":{"properties":{"type":{"type":"string","enum":["schema"],"title":"Type","default":"schema"},"operator":{"$ref":"#/components/schemas/EvaluationOperator"},"evaluateWithValue":{"title":"Evaluatewithvalue","type":"string"},"evaluateIfMissing":{"type":"boolean","title":"Evaluateifmissing"},"dataPointPath":{"type":"array","items":{"$ref":"#/components/schemas/Path"}}},"type":"object","required":["operator","dataPointPath"],"title":"SchemaEvaluation"}},"components/schemas/Path":{"id":"components/schemas/Path","kind":"json-schema","title":"Path","data":{"type":"string","title":"Path","description":"Path location."}},"components/schemas/Problem1":{"id":"components/schemas/Problem1","kind":"json-schema","title":"Problem1","data":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}}}},"components/schemas/WorkflowDefinition":{"id":"components/schemas/WorkflowDefinition","kind":"json-schema","title":"WorkflowDefinition","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the workflow definition"},"name":{"type":"string","description":"Name of the workflow"},"description":{"type":"string"},"companyId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"definition":{"type":"string","description":"YAML definition of the workflow"},"projectIds":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"versionString":{"type":"string"},"updatedBy":{"type":"string"},"createdById":{"type":"string"},"updatedById":{"type":"string"}},"required":["id","name","definition"]}},"components/schemas/WorkflowDefinitionsListResponse":{"id":"components/schemas/WorkflowDefinitionsListResponse","kind":"json-schema","title":"WorkflowDefinitionsListResponse","data":{"type":"object","required":["data","totalCount","limit","offset"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowDefinition"}},"totalCount":{"type":"integer","format":"int64","description":"The total number of workflow definitions available."},"limit":{"type":"integer","description":"The limit used for this page of results."},"offset":{"type":"integer","description":"The zero-based offset used for this page of results."}}}},"components/schemas/WorkflowDefinitionRequest":{"id":"components/schemas/WorkflowDefinitionRequest","kind":"json-schema","title":"WorkflowDefinitionRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the workflow"},"definition":{"type":"string","description":"YAML definition of the workflow"},"description":{"type":"string"},"projectIds":{"type":"array","items":{"type":"string"}}},"required":["name","definition"]}},"components/schemas/CompanyAccess":{"id":"components/schemas/CompanyAccess","kind":"json-schema","title":"CompanyAccess","data":{"title":"CompanyAccess","required":["companyId","companyName","active","createdAt","roles"],"type":"object","properties":{"companyId":{"title":"Company identifier","type":"string","example":"660572bc7a3cd6803f112252"},"companyName":{"title":"Company name","type":"string","example":"Company Inc."},"active":{"title":"If user is active for particular company","type":"boolean","example":true},"createdAt":{"title":"User membership creation date","type":"string","example":"2023-03-28T15:46:19.384990Z"},"createdBy":{"title":"Creator user identifier","type":"string","example":"660572bc7a3cd6803f112252"},"modifiedAt":{"title":"Modification date","type":"string","example":"2023-03-28T15:46:19.384990Z"},"modifiedBy":{"title":"Modfier user identifier","type":"string","example":"660572bc7a3cd6803f112252"},"roles":{"title":"User roles in particular company","type":"array","items":{"$ref":"#/components/schemas/RoleName"},"example":["clerk"]}}}},"components/schemas/RoleName":{"id":"components/schemas/RoleName","kind":"json-schema","title":"RoleName","data":{"title":"RoleName","enum":["installationAdmin","installationClerk","admin","clerk","manager","supportSpecialist"],"type":"string","description":"User role for particular company."}},"components/schemas/UserListResponse":{"id":"components/schemas/UserListResponse","kind":"json-schema","title":"UserListResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","title":"Data"},"totalCount":{"type":"integer","title":"Totalcount"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["data","totalCount","limit","offset"],"title":"UserListResponse"}},"components/schemas/UserResponse":{"id":"components/schemas/UserResponse","kind":"json-schema","title":"UserResponse","data":{"title":"UserResponse","required":["id","email","name","companiesAccess","active","isInternal"],"type":"object","properties":{"id":{"title":"User identifier","type":"string","example":"660572bc7a3cd6803f112252"},"email":{"title":"User email","type":"string","example":"firstname.lastname@company.inc"},"name":{"title":"User display name","type":"string","example":"Firstname Lastname"},"companiesAccess":{"title":"User companies memberships","type":"array","items":{"$ref":"#/components/schemas/CompanyAccess"}},"active":{"title":"If user is active","type":"boolean","example":true},"isInternal":{"title":"If user is considered internal Hypatos one","type":"boolean","example":false},"lastLoginAt":{"title":"Last login date","type":"string","example":"2023-03-28T15:46:19.384990Z"}}}},"components/schemas/DocumentsXml":{"id":"components/schemas/DocumentsXml","kind":"json-schema","title":"DocumentsXml","data":{"type":"string","format":"xml","description":"XML document produced by applying the project-specific list\ntransformation (XSLT) to the Studio response. The concrete element\nstructure is defined per project.\n","example":"<documents>\n  <document id=\"...\"/>\n</documents>\n"}},"components/schemas/DocumentXml":{"id":"components/schemas/DocumentXml","kind":"json-schema","title":"DocumentXml","data":{"type":"string","format":"xml","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XML document produced by applying the project-specific single-document"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transformation (XSLT) to the Studio response. May include inlined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base64 attachments when the rule has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addBinaryFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"example":"<document id=\"...\">\n  <attachment contentType=\"application/pdf\">BASE64...</attachment>\n</document>\n"}},"components/schemas/GenericError":{"id":"components/schemas/GenericError","kind":"json-schema","title":"GenericError","data":{"type":"object","description":"Error envelope returned by the API.","required":["status","title","detail"],"properties":{"status":{"type":"integer","format":"int32","description":"HTTP status code.","example":400},"title":{"type":"string","description":"Short, human-readable summary of the error.","example":"Incorrect input"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Required request parameter 'projectId' is not present."},"errorAt":{"type":"string","format":"date-time","description":"Timestamp at which the error was produced."}}}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"allOf":[{"$ref":"#/components/schemas/GenericError"},{"type":"object","properties":{"hypatosErrorMetaInfo":{"$ref":"#/components/schemas/ValidationErrorMetaInfo"}}}]}},"components/schemas/ValidationErrorMetaInfo":{"id":"components/schemas/ValidationErrorMetaInfo","kind":"json-schema","title":"ValidationErrorMetaInfo","data":{"type":"object","properties":{"invalidFields":{"type":"array","items":{"$ref":"#/components/schemas/ErrorField"}}}}},"components/schemas/ErrorField":{"id":"components/schemas/ErrorField","kind":"json-schema","title":"ErrorField","data":{"type":"object","required":["status","title","detail","fieldName"],"properties":{"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"detail":{"type":"string"},"fieldName":{"type":"string","description":"Name of the field that failed validation."}}}},"components/schemas/APIErrorResponse":{"id":"components/schemas/APIErrorResponse","kind":"json-schema","title":"APIErrorResponse","data":{"properties":{"status":{"type":"integer","title":"Status code","example":422},"title":{"type":"string","title":"Error title","example":"Request validation error"},"detail":{"type":"string","nullable":true,"title":"Error description","example":"Validation error details"}},"type":"object","required":["status","title"],"title":"APIErrorResponse"}},"components/schemas/AgentVersionMetadata":{"id":"components/schemas/AgentVersionMetadata","kind":"json-schema","title":"AgentVersionMetadata","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"version":{"type":"string","title":"Version"},"description":{"type":"string","nullable":true,"title":"Description"},"createdAt":{"type":"string","format":"date-time","nullable":true,"title":"Createdat"},"createdBy":{"type":"string","nullable":true,"title":"Createdby"}},"type":"object","required":["id","version"],"title":"AgentVersionMetadata"}},"components/schemas/BoundingBoxRegionDetectionMode":{"id":"components/schemas/BoundingBoxRegionDetectionMode","kind":"json-schema","title":"BoundingBoxRegionDetectionMode","data":{"type":"string","enum":["WORD_MATCHING","LLM"],"title":"BoundingBoxRegionDetectionMode"}},"components/schemas/Dict":{"id":"components/schemas/Dict","kind":"json-schema","title":"Dict","data":{"properties":{},"additionalProperties":true,"type":"object","title":"Dict"}},"components/schemas/ExternalAgentCreate":{"id":"components/schemas/ExternalAgentCreate","kind":"json-schema","title":"ExternalAgentCreate","data":{"properties":{"id":{"type":"string","format":"uuid","nullable":true,"title":"Id"},"companyId":{"type":"string","nullable":true,"title":"Companyid"},"name":{"type":"string","title":"Name","example":"Agent name"},"version":{"type":"string","nullable":true,"title":"Version"},"description":{"type":"string","title":"Description","example":"Some description"},"prompt":{"type":"string","title":"Prompt","description":"Prompt used for agent","example":"Hello GPT, how are you?"},"model":{"type":"string","nullable":true,"title":"Model","description":"Model UID used for this agent. If not specified, the default model will be used.","example":"b099cb97-4a5c-458f-8dcf-91139e731214"},"systemPrompt":{"type":"string","nullable":true,"title":"Systemprompt","description":"System prompt for the agent","example":"You are a helpful assistant."},"outputFormat":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Output format specification for the agent"},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit agent"},"configuration":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Additional agent configuration"},"toolIds":{"items":{"type":"string","format":"uuid"},"type":"array","nullable":true,"title":"Toolids","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids of the tools assigned to this agent. On create/update: null or omitted leaves the assignments unchanged (a new agent starts with none), [] removes them all, and a list replaces them with exactly this set (a change creates a new agent version). Populated on by-id reads and on a list with full=true; null in a list otherwise."},"children":[]}]}]}]},"type":{"type":"string","title":"Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of agent (BASIC, BASIC_V2, AGENTIC, METADATA, PAGE_BY_PAGE, LLM_OCR, STATIC, CASE_CLASSIFICATION, FILE_SUMMARIZATION, SCRIPT, AGENTIC_DECISION). SCRIPT runs author-provided TypeScript (from the prompt field, rendered with full mustache context) in a sandbox and returns JSON instead of calling an LLM."},"children":[]}]}]}],"example":"BASIC"}},"type":"object","required":["name","description","prompt","type"],"title":"ExternalAgentCreate","description":"Custom-agent create body; benign OOTB defaults are ignored, while OOTB claims are rejected."}},"components/schemas/ExternalAgent":{"id":"components/schemas/ExternalAgent","kind":"json-schema","title":"ExternalAgent","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","example":"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"},"rootAgentId":{"type":"string","format":"uuid","nullable":true,"title":"Rootagentid","example":"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"},"companyId":{"type":"string","title":"Companyid","example":"6081acde0377a83b93f05a10"},"name":{"type":"string","title":"Name","example":"Agent name"},"version":{"type":"string","title":"Version","example":"Agent version"},"description":{"type":"string","title":"Description","example":"Some description"},"prompt":{"type":"string","nullable":true,"title":"Prompt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prompt used for agent. Null in a lean list row — request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to load it."},"children":[]}]}]}],"example":"Hello GPT, how are you?"},"model":{"type":"string","nullable":true,"title":"Model","description":"Model UID used for this agent. If not specified, the default model will be used.","example":"b099cb97-4a5c-458f-8dcf-91139e731214"},"systemPrompt":{"type":"string","nullable":true,"title":"Systemprompt","description":"System prompt for the agent","example":"You are a helpful assistant."},"outputFormat":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Output format specification for the agent"},"createdAt":{"type":"string","format":"date-time","nullable":true,"title":"Createdat","description":"Date when Agent was added","example":"2023-10-27T11:38:18.000Z"},"createdBy":{"type":"string","nullable":true,"title":"Createdby","description":"Agent creator","example":"2023-10-27T11:38:18.000Z"},"updatedBy":{"type":"string","nullable":true,"title":"Updatedby","description":"Agent updater","example":"Updater"},"updatedAt":{"type":"string","format":"date-time","nullable":true,"title":"Updatedat","description":"Date when Agent was last modified","example":"2023-10-27T12:38:18.000Z"},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit agent"},"versions":{"items":{"$ref":"#/components/schemas/ExternalAgent"},"type":"array","title":"Versions","description":"Other versions of this agent"},"versionsMetadata":{"items":{"$ref":"#/components/schemas/AgentVersionMetadata"},"type":"array","title":"Versionsmetadata","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lightweight version summaries, populated when withVersionsMetadata=true"},"children":[]}]}]}]},"configuration":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Additional agent configuration"},"toolIds":{"items":{"type":"string","format":"uuid"},"type":"array","nullable":true,"title":"Toolids","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids of the tools assigned to this agent. On create/update: null or omitted leaves the assignments unchanged (a new agent starts with none), [] removes them all, and a list replaces them with exactly this set (a change creates a new agent version). Populated on by-id reads and on a list with full=true; null in a list otherwise."},"children":[]}]}]}]},"isOotb":{"type":"boolean","title":"Isootb","description":"Whether the agent is an out-of-the-box agent","default":false},"sourceTemplateAgentId":{"type":"string","format":"uuid","nullable":true,"title":"Sourcetemplateagentid","description":"Source template agent identifier"},"sourceTemplateAgentVersion":{"type":"string","nullable":true,"title":"Sourcetemplateagentversion","description":"Concrete source template agent version used for import"},"predefinedOutputFormat":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Read-only. The predefined output format of an OOTB agent, which customization may only extend with new properties: the template's, or the stored one when the template is gone. Populated on by-id reads; null when nothing is predefined, for custom agents, and for types whose output format is managed by Hypatos. Ignored on create and update."},"type":{"type":"string","title":"Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of agent (BASIC, BASIC_V2, AGENTIC, METADATA, PAGE_BY_PAGE, LLM_OCR, STATIC, CASE_CLASSIFICATION, FILE_SUMMARIZATION, SCRIPT, AGENTIC_DECISION). SCRIPT runs author-provided TypeScript (from the prompt field, rendered with full mustache context) in a sandbox and returns JSON instead of calling an LLM."},"children":[]}]}]}],"example":"BASIC"}},"type":"object","required":["id","companyId","name","version","description","type"],"title":"ExternalAgent","description":"An agent, as returned by the agents API."}},"components/schemas/ExternalAgentPage":{"id":"components/schemas/ExternalAgentPage","kind":"json-schema","title":"AgentPage","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ExternalAgent"},"type":"array","title":"Data","description":"The page of results."},"limit":{"type":"integer","title":"Limit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit applied to this page. Equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter unless it exceeded the maximum allowed value, in which case it is that maximum."},"children":[]}]}]}],"example":20},"offset":{"type":"integer","title":"Offset","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The offset applied to this page (echoes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter)."},"children":[]}]}]}],"example":0},"totalCount":{"type":"integer","title":"Totalcount","description":"The total number of elements across all pages.","example":137}},"type":"object","required":["data","limit","offset","totalCount"],"title":"AgentPage","description":"A page of agents."}},"components/schemas/ExternalAgentPatch":{"id":"components/schemas/ExternalAgentPatch","kind":"json-schema","title":"ExternalAgentPatch","data":{"properties":{"companyId":{"type":"string","nullable":true,"title":"Companyid"},"name":{"type":"string","nullable":true,"title":"Name"},"description":{"type":"string","nullable":true,"title":"Description"},"prompt":{"type":"string","nullable":true,"title":"Prompt","description":"Prompt used for agent"},"model":{"type":"string","nullable":true,"title":"Model","description":"Model UID used for this agent"},"systemPrompt":{"type":"string","nullable":true,"title":"Systemprompt","description":"System prompt for the agent"},"outputFormat":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Output format specification for the agent"},"configuration":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Additional agent configuration"},"editors":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Editors","description":"Editor ids that can edit agent"},"type":{"type":"string","nullable":true,"title":"Type","description":"The type of agent"},"toolIds":{"items":{"type":"string","format":"uuid"},"type":"array","nullable":true,"title":"Toolids","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids of the tools assigned to this agent. Omitted or null leaves the assignments unchanged; [] removes them all; a list replaces them with exactly this set (a change creates a new agent version)."},"children":[]}]}]}]}},"type":"object","title":"ExternalAgentPatch","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial-update body for an agent; send only the fields to change. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are immutable."},"children":[]}]}]}]}},"components/schemas/ExternalAgentWrite":{"id":"components/schemas/ExternalAgentWrite","kind":"json-schema","title":"ExternalAgentWrite","data":{"properties":{"id":{"type":"string","format":"uuid","nullable":true,"title":"Id"},"companyId":{"type":"string","nullable":true,"title":"Companyid"},"name":{"type":"string","title":"Name","example":"Agent name"},"version":{"type":"string","nullable":true,"title":"Version"},"description":{"type":"string","title":"Description","example":"Some description"},"prompt":{"type":"string","title":"Prompt","description":"Prompt used for agent","example":"Hello GPT, how are you?"},"model":{"type":"string","nullable":true,"title":"Model","description":"Model UID used for this agent. If not specified, the default model will be used.","example":"b099cb97-4a5c-458f-8dcf-91139e731214"},"systemPrompt":{"type":"string","nullable":true,"title":"Systemprompt","description":"System prompt for the agent","example":"You are a helpful assistant."},"outputFormat":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Output format specification for the agent"},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit agent"},"configuration":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Additional agent configuration"},"toolIds":{"items":{"type":"string","format":"uuid"},"type":"array","nullable":true,"title":"Toolids","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids of the tools assigned to this agent. On create/update: null or omitted leaves the assignments unchanged (a new agent starts with none), [] removes them all, and a list replaces them with exactly this set (a change creates a new agent version). Populated on by-id reads and on a list with full=true; null in a list otherwise."},"children":[]}]}]}]},"type":{"type":"string","title":"Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of agent (BASIC, BASIC_V2, AGENTIC, METADATA, PAGE_BY_PAGE, LLM_OCR, STATIC, CASE_CLASSIFICATION, FILE_SUMMARIZATION, SCRIPT, AGENTIC_DECISION). SCRIPT runs author-provided TypeScript (from the prompt field, rendered with full mustache context) in a sandbox and returns JSON instead of calling an LLM."},"children":[]}]}]}],"example":"BASIC"}},"type":"object","required":["name","description","prompt","type"],"title":"ExternalAgentWrite"}},"components/schemas/ExternalOotbAgentPatch":{"id":"components/schemas/ExternalOotbAgentPatch","kind":"json-schema","title":"ExternalOotbAgentPatch","data":{"properties":{"prompt":{"type":"string","title":"Prompt","description":"Prompt used for agent"},"description":{"type":"string","title":"Description","description":"Human-readable agent description"},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit agent"},"outputFormat":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"Output format with custom properties added to the predefined ones, which must stay unchanged. null removes it, allowed only when predefinedOutputFormat is null and the type's output format is not managed by Hypatos."}},"additionalProperties":false,"type":"object","title":"ExternalOotbAgentPatch","description":"Narrow external PATCH variant for a persisted OOTB agent."}},"components/schemas/ExternalOotbWorkflowPatch":{"id":"components/schemas/ExternalOotbWorkflowPatch","kind":"json-schema","title":"ExternalOotbWorkflowPatch","data":{"properties":{"workflowConfiguration":{"$ref":"#/components/schemas/Dict","title":"Workflowconfiguration","description":"Complete replacement for workflowConfiguration.steps. Send only the steps field; do not echo managed workflowConfiguration fields from a GET response. The server preserves those managed fields."},"name":{"type":"string","minLength":1,"title":"Name","description":"Workflow name"},"description":{"type":"string","title":"Description","description":"Workflow description"},"projects":{"type":"string","title":"Projects","description":"Comma separated list of projectIds"},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit workflow"}},"additionalProperties":false,"type":"object","title":"ExternalOotbWorkflowPatch","description":"Narrow external PATCH variant for a persisted OOTB workflow."}},"components/schemas/ExternalWorkflowCreate":{"id":"components/schemas/ExternalWorkflowCreate","kind":"json-schema","title":"ExternalWorkflowCreate","data":{"properties":{"id":{"type":"string","format":"uuid","nullable":true,"title":"Id"},"companyId":{"type":"string","nullable":true,"title":"Companyid"},"projects":{"type":"string","title":"Projects","description":"Comma separated list of projectIds","example":"6299d91c04dd5dd5d81c99bb,63bc7bf22b5bc8f3d0625092"},"name":{"type":"string","title":"Name","description":"Name for Workflow","example":"Some very nice workflow"},"model":{"type":"string","title":"Model","description":"Model id used for prompting","example":"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"},"description":{"type":"string","nullable":true,"title":"Description","description":"Description of Workflow","example":"Some more verbose description"},"trainingCompanyId":{"type":"string","nullable":true,"title":"Trainingcompanyid","example":"6081acde0377a83b93f05a10"},"trainingProjects":{"type":"string","nullable":true,"title":"Trainingprojects","description":"Comma separated list of training projectIds used as source documents repository","example":"6523b5bcac1cb469d7fc1bd9"},"similarityThreshold":{"type":"number","nullable":true,"title":"Similaritythreshold","description":"Defines the minimum similarity between the uploaded document and context examples from the training project","example":0.78},"useOcrTextPages":{"type":"boolean","nullable":true,"title":"Useocrtextpages","description":"Ability to use ocrTextPages (Google OCR) in the prompt ","default":false,"example":false},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit workflow"},"similarityApi":{"type":"boolean","nullable":true,"title":"Similarityapi","description":"Ability to set similarity service API for document training data","default":true,"example":true},"useImages":{"type":"boolean","nullable":true,"title":"Useimages","description":"Ability to set images usage to workflow","default":true,"example":false},"maxNumTrainingDocuments":{"type":"integer","title":"Maxnumtrainingdocuments","description":"Maximum number of training documents used in the workflow","default":1,"example":2},"bboxRegionDetectionMode":{"allOf":[{"$ref":"#/components/schemas/BoundingBoxRegionDetectionMode"}],"type":"string","nullable":true,"description":"The bounding boxes region detection mode of prompting-settings","example":"WORD_MATCHING"},"workflowType":{"allOf":[{"$ref":"#/components/schemas/WorkflowType"}],"type":"string","nullable":true,"description":"Type of workflow (EXTRACTION returns value-form entities, PREPROCESSING returns raw JSON)","default":"EXTRACTION"},"workflowConfiguration":{"$ref":"#/components/schemas/Dict","description":"The workflow's step configuration: the agents to run and how they are chained"}},"type":"object","required":["projects","name","model","workflowConfiguration"],"title":"ExternalWorkflowCreate","description":"Custom-workflow create body; OOTB identity and import provenance are server-managed."}},"components/schemas/ExternalWorkflow":{"id":"components/schemas/ExternalWorkflow","kind":"json-schema","title":"Workflow","data":{"properties":{"id":{"type":"string","format":"uuid","nullable":true,"title":"Id","example":"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"},"companyId":{"type":"string","title":"Companyid","example":"6081acde0377a83b93f05a10"},"projects":{"type":"string","title":"Projects","description":"Comma separated list of projectIds","example":"6299d91c04dd5dd5d81c99bb,63bc7bf22b5bc8f3d0625092"},"name":{"type":"string","title":"Name","description":"Name for Workflow","example":"Some very nice workflow"},"model":{"type":"string","title":"Model","description":"Model id used for prompting","example":"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"},"description":{"type":"string","nullable":true,"title":"Description","description":"Description of Workflow","example":"Some more verbose description"},"trainingCompanyId":{"type":"string","nullable":true,"title":"Trainingcompanyid","example":"6081acde0377a83b93f05a10"},"trainingProjects":{"type":"string","nullable":true,"title":"Trainingprojects","description":"Comma separated list of training projectIds used as source documents repository","example":"6523b5bcac1cb469d7fc1bd9"},"createdAt":{"type":"string","format":"date-time","nullable":true,"title":"Createdat","description":"Date when Workflow was added","example":"2023-10-27T11:38:18.000Z"},"createdBy":{"type":"string","nullable":true,"title":"Createdby","description":"Id of the caller that created the workflow; an OAuth client id when created via this API","example":"acme-integration"},"updatedBy":{"type":"string","nullable":true,"title":"Updatedby","description":"Id of the caller that last updated the workflow; an OAuth client id when updated via this API","example":"acme-integration"},"updatedAt":{"type":"string","format":"date-time","nullable":true,"title":"Updatedat","description":"Date when Workflow was last modified","example":"2023-10-27T12:38:18.000Z"},"similarityThreshold":{"type":"number","nullable":true,"title":"Similaritythreshold","description":"Defines the minimum similarity between the uploaded document and context examples from the training project","example":0.78},"useOcrTextPages":{"type":"boolean","nullable":true,"title":"Useocrtextpages","description":"Ability to use ocrTextPages (Google OCR) in the prompt ","default":false,"example":false},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit workflow"},"similarityApi":{"type":"boolean","nullable":true,"title":"Similarityapi","description":"Ability to set similarity service API for document training data","default":true,"example":true},"useImages":{"type":"boolean","nullable":true,"title":"Useimages","description":"Ability to set images usage to workflow","default":true,"example":false},"maxNumTrainingDocuments":{"type":"integer","title":"Maxnumtrainingdocuments","description":"Maximum number of training documents used in the workflow","default":1,"example":2},"bboxRegionDetectionMode":{"allOf":[{"$ref":"#/components/schemas/BoundingBoxRegionDetectionMode"}],"type":"string","nullable":true,"description":"The bounding boxes region detection mode of prompting-settings","example":"WORD_MATCHING"},"workflowType":{"allOf":[{"$ref":"#/components/schemas/WorkflowType"}],"type":"string","nullable":true,"description":"Type of workflow (EXTRACTION returns value-form entities, PREPROCESSING returns raw JSON)","default":"EXTRACTION"},"workflowConfiguration":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true,"description":"The workflow's step configuration: the agents to run and how they are chained"},"version":{"type":"string","nullable":true,"title":"Version","description":"Workflow version"},"sourceWorkflowId":{"type":"string","format":"uuid","nullable":true,"title":"Sourceworkflowid","description":"Source workflow identifier for imported workflows"},"sourceWorkflowVersion":{"type":"string","nullable":true,"title":"Sourceworkflowversion","description":"Concrete source workflow version used for import"},"isOotb":{"type":"boolean","title":"Isootb","description":"Whether persisted import provenance classifies this workflow as OOTB","default":false}},"type":"object","required":["companyId","projects","name","model"],"title":"Workflow","description":"A workflow, as returned by the workflows API."}},"components/schemas/ExternalWorkflowPage":{"id":"components/schemas/ExternalWorkflowPage","kind":"json-schema","title":"WorkflowPage","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ExternalWorkflow"},"type":"array","title":"Data","description":"The page of results."},"limit":{"type":"integer","title":"Limit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit applied to this page. Equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter unless it exceeded the maximum allowed value, in which case it is that maximum."},"children":[]}]}]}],"example":20},"offset":{"type":"integer","title":"Offset","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The offset applied to this page (echoes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter)."},"children":[]}]}]}],"example":0},"totalCount":{"type":"integer","title":"Totalcount","description":"The total number of elements across all pages.","example":137}},"type":"object","required":["data","limit","offset","totalCount"],"title":"WorkflowPage","description":"A page of workflows."}},"components/schemas/ExternalWorkflowPatch":{"id":"components/schemas/ExternalWorkflowPatch","kind":"json-schema","title":"ExternalWorkflowPatch","data":{"properties":{"companyId":{"type":"string","nullable":true,"title":"Companyid"},"projects":{"type":"string","nullable":true,"title":"Projects","description":"Comma separated list of projectIds"},"name":{"type":"string","nullable":true,"title":"Name","description":"Name for Workflow"},"model":{"type":"string","nullable":true,"title":"Model","description":"Model id used for prompting"},"description":{"type":"string","nullable":true,"title":"Description","description":"Description of Workflow"},"trainingCompanyId":{"type":"string","nullable":true,"title":"Trainingcompanyid"},"trainingProjects":{"type":"string","nullable":true,"title":"Trainingprojects","description":"Comma separated list of training projectIds"},"similarityThreshold":{"type":"number","nullable":true,"title":"Similaritythreshold"},"useOcrTextPages":{"type":"boolean","nullable":true,"title":"Useocrtextpages"},"editors":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Editors","description":"Editor ids that can edit workflow"},"similarityApi":{"type":"boolean","nullable":true,"title":"Similarityapi"},"useImages":{"type":"boolean","nullable":true,"title":"Useimages"},"maxNumTrainingDocuments":{"type":"integer","nullable":true,"title":"Maxnumtrainingdocuments"},"bboxRegionDetectionMode":{"allOf":[{"$ref":"#/components/schemas/BoundingBoxRegionDetectionMode"}],"type":"string","nullable":true},"workflowType":{"allOf":[{"$ref":"#/components/schemas/WorkflowType"}],"type":"string","nullable":true},"workflowConfiguration":{"allOf":[{"$ref":"#/components/schemas/Dict"}],"type":"object","nullable":true}},"type":"object","title":"ExternalWorkflowPatch","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial-update body for a workflow; send only the fields to change. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is immutable."},"children":[]}]}]}]}},"components/schemas/ExternalWorkflowWrite":{"id":"components/schemas/ExternalWorkflowWrite","kind":"json-schema","title":"ExternalWorkflowWrite","data":{"properties":{"id":{"type":"string","format":"uuid","nullable":true,"title":"Id"},"companyId":{"type":"string","nullable":true,"title":"Companyid"},"projects":{"type":"string","title":"Projects","description":"Comma separated list of projectIds","example":"6299d91c04dd5dd5d81c99bb,63bc7bf22b5bc8f3d0625092"},"name":{"type":"string","title":"Name","description":"Name for Workflow","example":"Some very nice workflow"},"model":{"type":"string","title":"Model","description":"Model id used for prompting","example":"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"},"description":{"type":"string","nullable":true,"title":"Description","description":"Description of Workflow","example":"Some more verbose description"},"trainingCompanyId":{"type":"string","nullable":true,"title":"Trainingcompanyid","example":"6081acde0377a83b93f05a10"},"trainingProjects":{"type":"string","nullable":true,"title":"Trainingprojects","description":"Comma separated list of training projectIds used as source documents repository","example":"6523b5bcac1cb469d7fc1bd9"},"similarityThreshold":{"type":"number","nullable":true,"title":"Similaritythreshold","description":"Defines the minimum similarity between the uploaded document and context examples from the training project","example":0.78},"useOcrTextPages":{"type":"boolean","nullable":true,"title":"Useocrtextpages","description":"Ability to use ocrTextPages (Google OCR) in the prompt ","default":false,"example":false},"editors":{"items":{"type":"string"},"type":"array","title":"Editors","description":"Editor ids that can edit workflow"},"similarityApi":{"type":"boolean","nullable":true,"title":"Similarityapi","description":"Ability to set similarity service API for document training data","default":true,"example":true},"useImages":{"type":"boolean","nullable":true,"title":"Useimages","description":"Ability to set images usage to workflow","default":true,"example":false},"maxNumTrainingDocuments":{"type":"integer","title":"Maxnumtrainingdocuments","description":"Maximum number of training documents used in the workflow","default":1,"example":2},"bboxRegionDetectionMode":{"allOf":[{"$ref":"#/components/schemas/BoundingBoxRegionDetectionMode"}],"type":"string","nullable":true,"description":"The bounding boxes region detection mode of prompting-settings","example":"WORD_MATCHING"},"workflowType":{"allOf":[{"$ref":"#/components/schemas/WorkflowType"}],"type":"string","nullable":true,"description":"Type of workflow (EXTRACTION returns value-form entities, PREPROCESSING returns raw JSON)","default":"EXTRACTION"},"workflowConfiguration":{"$ref":"#/components/schemas/Dict","description":"The workflow's step configuration: the agents to run and how they are chained"},"version":{"type":"string","nullable":true,"title":"Version"}},"type":"object","required":["projects","name","model","workflowConfiguration"],"title":"ExternalWorkflowWrite","description":"Replace (PUT) body for a custom workflow."}},"components/schemas/WorkflowType":{"id":"components/schemas/WorkflowType","kind":"json-schema","title":"WorkflowType","data":{"type":"string","enum":["EXTRACTION","PREPROCESSING"],"title":"WorkflowType"}},"components/schemas/APIErrorResponse1":{"id":"components/schemas/APIErrorResponse1","kind":"json-schema","title":"APIErrorResponse","data":{"properties":{"status":{"type":"integer","title":"Status code","example":404},"title":{"type":"string","title":"Error title","example":"Not Found"},"detail":{"type":"string","title":"Error details","example":"Details information"}},"type":"object","required":["status","title"],"title":"APIErrorResponse"}},"components/schemas/ProcessingModeListResponse":{"id":"components/schemas/ProcessingModeListResponse","kind":"json-schema","title":"ProcessingModeListResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProcessingModeResponse"},"type":"array","title":"Processing modes list"},"totalCount":{"type":"integer","title":"The total number of elements of the data attribute.","example":3},"limit":{"type":"integer","title":"The limit used for this page of results. This will be the same as the limit query parameter unless it exceeds the maximal allowed value.","example":20},"offset":{"type":"integer","title":"The offset used for this page of results. This will be the same as the offset query parameter.","example":0}},"type":"object","required":["data","totalCount","limit","offset"],"title":"ProcessingModeListResponse"}},"components/schemas/ProcessingModeResponse":{"id":"components/schemas/ProcessingModeResponse","kind":"json-schema","title":"ProcessingModeResponse","data":{"properties":{"id":{"type":"string","title":"Processing mode identifier","example":"65327bc75e386382268d13d3"},"name":{"type":"string","title":"Processing mode display name","example":"Invoice Extraction"},"disabled":{"type":"boolean","title":"Whether the processing mode is disabled","example":false}},"type":"object","required":["id","name","disabled"],"title":"ProcessingModeResponse"}},"components/schemas/Variable":{"id":"components/schemas/Variable","kind":"json-schema","title":"Variable","data":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"Variable name (camelCase, alphanumeric only, max 20 characters)","example":"databaseUrl"},"value":{"type":"string","description":"Variable value (not empty, max 100 characters, must not start or end with whitespace, no tabs/newlines)","example":"local_dev_db"},"description":{"type":"string","description":"Human-readable description of the variable","example":"Connection string for the PostgreSQL database"}}}},"components/schemas/ConfigurationScopeRequest":{"id":"components/schemas/ConfigurationScopeRequest","kind":"json-schema","title":"ConfigurationScopeRequest","data":{"type":"object","required":["variables"],"properties":{"scopeType":{"$ref":"#/components/schemas/ScopeType"},"scopeId":{"type":"string","description":"Scope identifier (required when scopeType is set)","example":"66e80e8f4e8215461076e24b"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}},"updatedBy":{"type":"string","deprecated":true,"description":"Deprecated - the acting user is the token's subject. Read only when both the subject and the X-Hy-Meta-User-Id header are missing or blank.\n","example":"66f2b0c4a1d3e5f6a7b8c9d0"}}}},"components/schemas/ConfigurationScope":{"id":"components/schemas/ConfigurationScope","kind":"json-schema","title":"ConfigurationScope","data":{"type":"object","required":["variables"],"properties":{"scopeType":{"$ref":"#/components/schemas/ScopeType"},"scopeId":{"type":"string"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"HTTP status text","example":"Bad Request"},"message":{"type":"string","description":"Human-readable error message","example":"Variable names may only contain alphanumeric characters ([a-z], [A-Z], [0-9])."}}}},"components/schemas/ScopeType":{"id":"components/schemas/ScopeType","kind":"json-schema","title":"ScopeType","data":{"type":"string","enum":["PROJECT","PS_WORKFLOW","PS_AGENT","CE_WORKFLOW"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"required":["detail","status","title"],"properties":{"detail":{"type":"string","description":"A human readable explanation of the error."},"status":{"type":"integer","format":"int32","description":"The HTTP status code.","minimum":100,"maximum":599},"title":{"type":"string","description":"A short summary of the error"}}}},"components/schemas/document":{"id":"components/schemas/document","kind":"json-schema","title":"document","data":{"type":"object","description":"Reference to document uploaded to Hypatos Studio","properties":{"id":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"63cac12c37bb02accb396cae","pattern":"^[0-9a-fA-F]{24}$"},"type":{"type":"string","description":"Document type that was assigned during upload to Hypatos","example":"invoice","pattern":"^\\S+$"}}}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","nullable":true,"description":"Three letter currency code as defined in ISO 4217","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL",null]}},"components/schemas/LanguageCode":{"id":"components/schemas/LanguageCode","kind":"json-schema","title":"LanguageCode","data":{"type":"string","nullable":true,"description":"Two letter language code as defined in ISO 639-1","example":"en","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu",null]}},"components/schemas/languagedText":{"id":"components/schemas/languagedText","kind":"json-schema","title":"languagedText","data":{"type":"object","properties":{"text":{"type":"string","description":"Text content","example":"Fish & Chips"},"language":{"$ref":"#/components/schemas/LanguageCode"}}}},"components/schemas/paymentTerms":{"id":"components/schemas/paymentTerms","kind":"json-schema","title":"paymentTerms","data":{"type":"object","properties":{"paymentTermKey":{"type":"string","description":"Key of the payment term as defined in the source system","example":"T10"},"descriptions":{"type":"array","description":"Descriptions of the payment terms in different languages","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Please pay us","language":"en"}]}}}},"components/schemas/customFields":{"id":"components/schemas/customFields","kind":"json-schema","title":"customFields","data":{"type":"object","description":"List of key value pairs containing custom fields from the source system","additionalProperties":{"type":"string"}}},"components/schemas/JsonObject":{"id":"components/schemas/JsonObject","kind":"json-schema","title":"JsonObject","data":{"type":"object","description":"Any nested structure with metadata that source system needs to send","additionalProperties":true,"example":{"someTopLevelProperty":"value1","someNestedProperty":{"nestedProperty":"value2"},"someArrayProperty":["value3","value4"]}}},"components/schemas/accountAssignment":{"id":"components/schemas/accountAssignment","kind":"json-schema","title":"accountAssignment","data":{"type":"object","properties":{"externalGlAccountId":{"type":"string","description":"External unique id of the general ledger account in the source system","example":"0000100GL1"},"externalCostCenterId":{"type":"string","description":"External unique id of the cost center in the source system","example":"0000100CO1"},"glAccountCode":{"type":"string","description":"General ledger account code","example":"GL1"},"costCenterCode":{"type":"string","description":"Cost center code","example":"CO1"},"quantity":{"type":"number","description":"Quantity of the invoice line (split of the quantity in case of several accountAssignments)","example":2},"externalProjectId":{"type":"string","description":"External id for project assignment","example":"EPI1"},"externalOrderId":{"type":"string","description":"External id for order assignment","example":"EOI1"},"costElementCode":{"type":"string","description":"Cost element code assignment","example":"CE1"},"externalProfitCenterId":{"type":"string","description":"External unique id of the profit center in the source system","example":"EPCI1"},"profitCenterCode":{"type":"string","description":"Profit center code","example":"PCC1"}}}},"components/schemas/taxCode":{"id":"components/schemas/taxCode","kind":"json-schema","title":"taxCode","data":{"type":"object","properties":{"code":{"type":"string","description":"Unique code of the type of tax in the source system","example":"DEU_Standard"},"description":{"type":"string","description":"Description of the type of tax in the source system","example":"DEU - Standard (19%)"}}}},"components/schemas/invoiceLine":{"id":"components/schemas/invoiceLine","kind":"json-schema","title":"invoiceLine","data":{"type":"object","properties":{"externalId":{"type":"string","description":"External id of the invoice line that is globally unique across the provided invoice line data","example":"00000001","pattern":"^\\S+$"},"externalCompanyId":{"type":"string","description":"Company that the invoice line is assigned to","example":"DE01"},"accountAssignments":{"type":"array","items":{"$ref":"#/components/schemas/accountAssignment"}},"type":{"type":"string","description":"type of the invoice line as defined in the source system","example":"Service"},"quantity":{"type":"number","description":"Quantity of the invoice line (sum of all quantity splits in case of several accountAssignments)","example":2},"netAmount":{"type":"number","description":"Net amount of the invoice line","example":1.23},"totalTaxAmount":{"type":"number","description":"Total tax amount of the invoice line","example":1.23},"grossAmount":{"type":"number","description":"Gross amount of the invoice line","example":100.01},"unitOfMeasure":{"type":"string","description":"Unit of measure of the invoice line","example":"kg"},"unitPrice":{"type":"number","description":"Price for one unit of the invoice line","example":19.0123},"taxCode":{"$ref":"#/components/schemas/taxCode"},"taxJurisdictionCode":{"type":"string","description":"tax jurisdiction code assigned to the invoice","example":"PA0000000"},"itemText":{"type":"string","description":"Text describing the invoice line item","example":"Virtual Event ABC"},"externalPurchaseOrderId":{"type":"string","description":"Purchase order related to the invoice line item","example":"4500016221"},"purchaseOrderLineNumber":{"type":"string","description":"Reference to the purchase order line item assigned to the invoice line item","example":"00010"},"salesOrderNumber":{"type":"string","description":"Sales order related to the invoice line item","example":"45001234"},"salesOrderLineNumber":{"type":"string","description":"Reference to the sales order line item assigned to the invoice line item","example":"20"},"centralBankIndicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State Central Bank Indicator for reporting foreign payment transactions according to the German Foreign Trade and Payments Ordinance (Außenwirtschaftsverordnung - AWV)"},"children":[]}]}]}],"example":"123"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/withholdingTax":{"id":"components/schemas/withholdingTax","kind":"json-schema","title":"withholdingTax","data":{"type":"object","description":"Withholding tax information related to a posted invoice","properties":{"key":{"type":"string","description":"Key that the source system uses to clearly identify the type of withholding tax that needs to be paid","example":"WHT-432"},"baseAmount":{"type":"number","description":"Base amount that the tax rate of the specific withholding tax type is applied to","example":632.78},"amount":{"type":"number","description":"Tax amount that was paid for the specific withholding tax type","example":21.39},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/invoice":{"id":"components/schemas/invoice","kind":"json-schema","title":"invoice","data":{"required":["externalId","invoiceLines"],"type":"object","properties":{"externalId":{"type":"string","description":"External id of the invoice that is globally unique across the provided invoice data","example":"SUPPLIER_INVOICE-3-1","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"documentId":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"63cac12c37bb02accb396cae","pattern":"^[0-9a-fA-F]{24}$"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"}},"supplierInvoiceNumber":{"type":"string","description":"Invoice number provided by the issuing supplier","example":"10000001"},"invoiceNumber":{"type":"string","description":"Number of the invoice in the source system (not unique across clients)","example":"12345"},"externalCompanyId":{"type":"string","description":"External unique id of the company in the source system","example":"DE01"},"externalSupplierId":{"type":"string","description":"External unique id of the supplier in the source system","example":"0000100000"},"externalBankAccountId":{"type":"string","description":"External unique id of the bank account that the invoice payment was transferred to","example":"12341234"},"fiscalYearLabel":{"type":"string","description":"Label used in the source system for the fiscal year that the invoice was posted in","example":"2023"},"issuedDate":{"type":"string","description":"Date when the invoice was issued by the supplier (printed on invoice document)","format":"date","example":"2000-12-31"},"receivedDate":{"type":"string","description":"Date when the invoice was recieved by the company","format":"date","example":"2000-12-31"},"postingDate":{"type":"string","description":"Date when the invoice was posted in the source system","format":"date","example":"2000-12-31"},"isCanceled":{"type":"boolean","description":"Indicator if the invoice is canceled","example":false},"isCreditNote":{"type":"boolean","description":"Indicator if the document is a credit note"},"externalCustomerId":{"type":"string","description":"External unique id of the customer in the source system"},"relatedInvoice":{"type":"string","description":"externalInvoiceId of related invoice","example":"SUPPLIER_INVOICE-3-2"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totalNetAmount":{"type":"number","description":"Total net amount of invoice (sum of line item net amounts)","example":81},"totalFreightCharges":{"type":"number","description":"Sum of all freight charges","example":9},"totalOtherCharges":{"type":"number","description":"Sum of all charges other than freight charges","example":10},"totalTaxAmount":{"type":"number","description":"Total tax amount of invoice (sum of all taxes)","example":19},"totalGrossAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total gross amount of invoice (total net amount + total freight charges + total other charges + total tax amount)"},"children":[]}]}]}],"example":119},"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"externalApproverId":{"type":"string","description":"External unique id of the first approver of an invoice in the source system","example":"UserID#1234"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"headerText":{"type":"string","description":"Header Text describing the invoice","example":"doc header text"},"type":{"type":"string","description":"type of the invoice as defined in th source system","example":"FI"},"invoiceLines":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/invoiceLine"}},"withholdingTax":{"type":"array","items":{"$ref":"#/components/schemas/withholdingTax"}},"documentType":{"type":"string","description":"document type as defined in the source system","example":"supplier invoice"}}}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"type":"string","nullable":true,"description":"Two letter country code as defined in ISO 3166-1 alpha-2","example":"DE","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW",null]}},"components/schemas/vatId":{"id":"components/schemas/vatId","kind":"json-schema","title":"vatId","data":{"type":"object","description":"List of VAT IDs assigned to the company","properties":{"id":{"type":"string"},"countryCode":{"$ref":"#/components/schemas/CountryCode"}},"example":[{"id":"DE123456789","countryCode":"DE"}]}},"components/schemas/taxId":{"id":"components/schemas/taxId","kind":"json-schema","title":"taxId","data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"example":[{"id":"123-456-789","type":"TIN"}]}},"components/schemas/company":{"id":"components/schemas/company","kind":"json-schema","title":"company","data":{"required":["name","externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External id of the company that is globally unique across the provided company data","example":"DE01","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the company in the source system (not unique across clients)","example":"CODE1"},"name":{"type":"string","description":"Name of the company","example":"Acmne Corp.","pattern":"^[\\S ]*\\S[\\S ]*$"},"nameAlternative1":{"type":"string","description":"Alternative name of the company","example":"Acmne Corp."},"nameAlternative2":{"type":"string","description":"Alternative name of the company","example":"Acmne Corp."},"nameAlternative3":{"type":"string","description":"Alternative name of the company","example":"Acmne Corp."},"nameAlternative4":{"type":"string","description":"Alternative name of the company","example":"Acmne Corp."},"street":{"type":"string","description":"Street and street number where the company is located","example":"Hauptstr. 1"},"addressAdditional":{"type":"string","description":"Additional address data (e.g. apartment or suite)","example":"Eingang B"},"postcode":{"type":"string","description":"Postcode where the company is located","example":"10001"},"city":{"type":"string","description":"City where the company is located","example":"Berlin"},"state":{"type":"string","description":"State where the company is located","example":"Berlin"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"vatIds":{"type":"array","description":"List of VAT IDs assigned to the company","example":[{"id":"DE123456789","countryCode":"DE"}],"items":{"$ref":"#/components/schemas/vatId"}},"taxIds":{"type":"array","description":"List of Tax IDs assigned to the company","example":[{"id":"123-456-789","type":"TIN"}],"items":{"$ref":"#/components/schemas/taxId"}},"globalLocationNumber":{"type":"string","description":"13-digit Global Location Number (GLN) used for unique location identification in B2B transactions","example":"4000001000002"},"duns":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D-U-N-S Number issued by Dun & Bradstreet. A globally used identifier for business entities."},"children":[]}]}]}],"example":"123456789"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/defaultAssignments":{"id":"components/schemas/defaultAssignments","kind":"json-schema","title":"defaultAssignments","data":{"type":"object","properties":{"defaultAccountAssignment":{"type":"object","properties":{"glAccountCode":{"type":"string","description":"Default general ledger account that is assigned to the supplier","example":"0000100GL1"},"costCenterCode":{"type":"string","description":"Default cost center account that is assigned to the supplier","example":"0000100CC1"},"externalApproverId":{"type":"string","description":"Default external approver ID that is assigned to the supplier","example":"MMUSTERMANN"},"externalProjectId":{"type":"string","description":"Default external project ID that is assigned to the supplier","example":"PROJ1234"},"externalOrderId":{"type":"string","description":"Default external order ID that is assigned to the supplier","example":"ORDER1234"}}}}}},"components/schemas/withholdingTaxInfo":{"id":"components/schemas/withholdingTaxInfo","kind":"json-schema","title":"withholdingTaxInfo","data":{"type":"object","description":"Withholding tax information related to a supplier","properties":{"key":{"type":"string","description":"Key that the source system uses to clearly identify the type of withholding tax that needs to be paid","example":"WHT-432"},"descriptions":{"type":"array","description":"Descriptions of the type of withholding tax","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Some very deep description of the type of withholding tax","language":"en"}]}}}},"components/schemas/subsidiary":{"id":"components/schemas/subsidiary","kind":"json-schema","title":"subsidiary","data":{"allOf":[{"$ref":"#/components/schemas/defaultAssignments"},{"type":"object","required":["externalCompanyId"],"properties":{"externalCompanyId":{"type":"string","description":"External unique id of the company that the subsidiary is assigned to","example":"DE01"},"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"blockedForPosting":{"type":"boolean","description":"Indicator if the subsidiary is blocked for posting","example":false},"blockedForPayment":{"type":"boolean","description":"Indicator if the subsidiary is blocked for payment","example":false},"enabledForAutoPosting":{"type":"boolean","description":"Indicator if the subsidiary is enabled for auto posting","example":true},"withholdingTaxInfo":{"type":"array","items":{"$ref":"#/components/schemas/withholdingTaxInfo"}}}}]}},"components/schemas/bankAccount":{"id":"components/schemas/bankAccount","kind":"json-schema","title":"bankAccount","data":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"External id of the bank account that is globally unique across the provided bank account data","example":"12341234","pattern":"^\\S+$"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"bankAccountNumber":{"type":"string","description":"Bank account number of the bank account","example":"78090"},"bankAccountHolder":{"type":"string","description":"Name of the bank account holder","example":"Maximilian Mustermann"},"iban":{"type":"string","description":"IBAN of the bank account","example":"DE91100000000123456789"},"bic":{"type":"string","description":"Bank identifier code","example":"CHASUS33XXX"},"bankName":{"type":"string","description":"Name of the bank where the bank account is held","example":"Deutsche Bank"},"bankStreet":{"type":"string","description":"Street and street number where the bank is located","example":"Hauptstr. 1"},"bankPostcode":{"type":"string","description":"Postcode where the bank is located.","example":"10001"},"bankCity":{"type":"string","description":"City where the bank is located.","example":"Berlin"},"isActive":{"type":"boolean","example":true},"type":{"type":"string","description":"Type of bank account.","example":"SAVINGS"},"bankKey":{"type":"string","description":"Unique key of the bank.","example":"60-16-13"}}}},"components/schemas/supplier":{"id":"components/schemas/supplier","kind":"json-schema","title":"supplier","data":{"allOf":[{"$ref":"#/components/schemas/defaultAssignments"},{"type":"object","required":["name","externalId"],"properties":{"externalId":{"type":"string","description":"External id of the supplier that is globally unique across the provided supplier data","example":"0000100000","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the supplier in the source system (not unique across clients)","example":"CODE1"},"type":{"type":"string","description":"Type assigned to the supplier in the source system. Can be used to categorize suppliers and control supplier-specific processing logic.","example":"SUPPLIER_TYPE_01"},"group":{"type":"string","description":"Group identifier assigned to the supplier in the source system. Can be used to associate multiple supplier records that belong to the same corporate group or other supplier grouping.","example":"GROUP_001"},"name":{"type":"string","description":"Name of the supplier","example":"Acmne Corp.","pattern":"^[\\S ]*\\S[\\S ]*$"},"nameAlternative1":{"type":"string","description":"Alternative name of the supplier","example":"Acmne Corp."},"nameAlternative2":{"type":"string","description":"Alternative name of the supplier","example":"Acmne Corp."},"nameAlternative3":{"type":"string","description":"Alternative name of the supplier","example":"Acmne Corp."},"nameAlternative4":{"type":"string","description":"Alternative name of the supplier","example":"Acmne Corp."},"alternativePayee":{"type":"string","pattern":"^\\S+$","description":"externalId of the supplier which is the alternative payee for this supplier"},"street":{"type":"string","description":"Street and street number where the supplier is located","example":"Hauptstr. 1"},"addressAdditional":{"type":"string","description":"Additional address data (e.g. apartment or suite)","example":"Eingang B"},"postcode":{"type":"string","description":"Postcode where the supplier is located","example":"10001"},"city":{"type":"string","description":"City where the supplier is located","example":"Berlin"},"state":{"type":"string","description":"State where the company is located","example":"Berlin"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"vatIds":{"type":"array","description":"List of VAT IDs assigned to the supplier","example":[{"id":"DE123456789","countryCode":"DE"}],"items":{"$ref":"#/components/schemas/vatId"}},"taxIds":{"type":"array","description":"List of Tax IDs assigned to the supplier","example":[{"id":"123-456-789","type":"TIN"}],"items":{"$ref":"#/components/schemas/taxId"}},"blockedForPosting":{"type":"boolean","description":"Indicator if the supplier is blocked for posting","example":false},"blockedForPayment":{"type":"boolean","description":"Indicator if the supplier is blocked for payment","example":false},"globalLocationNumber":{"type":"string","description":"13-digit Global Location Number (GLN) used for unique location identification in B2B transactions","example":"4000001000002"},"duns":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D-U-N-S Number issued by Dun & Bradstreet. A globally used identifier for business entities."},"children":[]}]}]}],"example":"123456789"},"supplierSubsidiaries":{"type":"array","items":{"$ref":"#/components/schemas/subsidiary"}},"supplierBankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/bankAccount"}},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}]}},"components/schemas/invoicingStatus":{"id":"components/schemas/invoicingStatus","kind":"json-schema","title":"invoicingStatus","data":{"type":"string","description":"Indicates the invoicing progress of the purchase order (line) based on invoices posted against it","example":"partial","enum":["outstanding","partial","complete"],"x-enum-descriptions":["No invoice has been posted yet","One or more invoices have been posted, but the total invoiced net amount is still below the expected total net amount","One or more invoices have been posted and the expected total net amount has been fully reached or exceeded"]}},"components/schemas/deliveryStatus":{"id":"components/schemas/deliveryStatus","kind":"json-schema","title":"deliveryStatus","data":{"type":"string","description":"Indicates the delivery progress of the purchase order (line) based on goods receipts or service confirmations","example":"partial","enum":["outstanding","partial","complete"],"x-enum-descriptions":["No deliveries have been received yet","One or more deliveries have been received, but the total delivered quantity is still below the expected total quantity","One or more deliveries have been received and the expected total quantity has been fully reached or exceeded"]}},"components/schemas/material":{"id":"components/schemas/material","kind":"json-schema","title":"material","data":{"type":"object","properties":{"externalId":{"type":"string","description":"External id of the material that is globally unique across the provided material data","example":"2a6300181f08402e710ea3f180214bc1","pattern":"^\\S+$"},"supplierNumber":{"type":"string","description":"Number of the material as defined by the supplier","example":"123456789"},"type":{"type":"string","description":"Type of the material as defined in the material master of the company","example":"Operating Supplies"},"group":{"type":"string","description":"Group of the material as defined in the material master of the company","example":"Electronics"},"description":{"type":"string","description":"Description of the material","example":"Dell Laptop Latitude D630"},"manufacturer":{"type":"string","description":"Name of the manufacturer of the material","example":"Acme Corporation"},"manufacturerNumber":{"type":"string","description":"Number of the material as defined by the manufacturer","example":"ACME-12345"},"unspsc":{"type":"string","description":"United Nations Standard Products and Services Code of the material","example":"43211508"},"ean":{"type":"string","description":"European Article Number (EAN-13)","example":"4006381333931"},"baseUnitOfMeasure":{"type":"string","description":"The base unit of measure in which the material is managed in the source system.","example":"PCE"}}}},"components/schemas/deliveryAddress":{"id":"components/schemas/deliveryAddress","kind":"json-schema","title":"deliveryAddress","data":{"type":"object","description":"Delivery address associated with the purchase order line. Represents the physical destination where goods or services are delivered","properties":{"street":{"type":"string","description":"Street name and house number of the delivery address","example":"123 Industrial Way"},"addressAdditional":{"type":"string","description":"Additional address data (e.g. apartment or suite)","example":"Suite 500, Dock 4"},"postcode":{"type":"string","description":"Postcode of the delivery address","example":"90001"},"city":{"type":"string","description":"City of the delivery address","example":"Los Angeles"},"state":{"type":"string","description":"State of the delivery address","example":"CA"},"countryCode":{"$ref":"#/components/schemas/CountryCode"}}}},"components/schemas/orderConfirmation":{"id":"components/schemas/orderConfirmation","kind":"json-schema","title":"orderConfirmation","data":{"type":"object","description":"Object containing order confirmation details provided by the supplier for the purchase order line","properties":{"lineNumber":{"type":"string","description":"Number of the order conformation line assigned (unique within the order confirmation)","example":"0090"},"deliveryDate":{"type":"string","description":"Confirmed delivery date provided by the supplier (YYYY-MM-DD)","format":"date","example":"2024-10-15"},"quantity":{"type":"number","description":"Quantity confirmed by the supplier for the specified delivery date","example":95},"supplierReference":{"type":"string","description":"Reference number assigned by the supplier for the order confirmation","example":"SUP-REF-00192"},"createdAt":{"type":"string","description":"Date when the order confirmation was created in the source system (YYYY-MM-DD)","format":"date","example":"2024-09-01"}}}},"components/schemas/purchaseOrderLineCondition":{"id":"components/schemas/purchaseOrderLineCondition","kind":"json-schema","title":"purchaseOrderLineCondition","data":{"type":"object","description":"Pricing condition record of a purchase order line as defined in the source system","properties":{"conditionType":{"type":"string","description":"Condition type as defined in the source system (customer-specific, not restricted to a list)","example":"ZL01"},"description":{"type":"string","description":"Description of the condition type","example":"Alloy surcharge"},"amount":{"type":"number","description":"Amount of the condition, negative for discounts","example":12.5},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/purchaseOrderLine":{"id":"components/schemas/purchaseOrderLine","kind":"json-schema","title":"purchaseOrderLine","data":{"required":["purchaseOrderLineNumber"],"type":"object","properties":{"purchaseOrderLineNumber":{"type":"string","description":"Number of the purchase order line assigned to the invoice line item (unique within the purchase order)","example":"00010"},"externalCompanyId":{"type":"string","description":"Company that the purchase order line is assgined to","example":"DE01"},"accountAssignments":{"type":"array","items":{"$ref":"#/components/schemas/accountAssignment"}},"type":{"type":"string","description":"type of the purchase order line as defined in the source system","example":"Service"},"subType":{"type":"string","description":"subtype of the purchase order as defined in the source system","example":"Extra Qualifier"},"quantity":{"type":"number","description":"Quantity of the purchase order line (sum of all quantity splits in case of several accountAssignments)","example":2},"status":{"type":"string","description":"Status of purchase order line as defined in source system","example":"OPEN"},"invoicingStatus":{"$ref":"#/components/schemas/invoicingStatus"},"deliveryStatus":{"$ref":"#/components/schemas/deliveryStatus"},"netAmount":{"type":"number","description":"Net amount of the purchase order line","example":1.23},"totalTaxAmount":{"type":"number","description":"Total tax amount of the purchase order line","example":1.23},"grossAmount":{"type":"number","description":"Gross amount of the purchase order line","example":100.01},"unitOfMeasure":{"type":"string","description":"Unit of measure of the purchase order line (usually the unit of measure in which the supplier will deliver the ordered material).","example":"kg"},"orderUnit":{"type":"object","description":"Unit of measure in which the material was ordered on the purchase order line and its conversion to the base unit of measure","properties":{"unitOfMeasure":{"type":"string","description":"The unit of measure in which the material was ordered on the purchase order line","example":"KAR"},"conversionFactorToBaseUnit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversion factor for converting a quantity in order unit to a quantity in base unit. For example, if the base unit is PCE, the order unit is KAR, and the conversion factor is 30, then 1 KAR = 30 PCE."},"children":[]}]}]}],"example":30}}},"unitPrice":{"type":"number","description":"Price for one unit of the purchase order line","example":19.0123},"taxCode":{"$ref":"#/components/schemas/taxCode"},"itemText":{"type":"string","description":"Text describing the purchase order line","example":"Dell Laptop Latitude D630"},"material":{"$ref":"#/components/schemas/material"},"plant":{"type":"string","description":"Location where purchased goods and services are consumed","example":"PLANT-001"},"delivered":{"type":"boolean","description":"Indicator if the purchase order line item was delivered","example":true},"completelyInvoiced":{"type":"boolean","description":"Indicator if the purchase order line item was fully invoiced","example":true},"approved":{"type":"boolean","description":"Indicator if the purchase order line item has been approved","example":true},"plannedDeliveryDate":{"type":"string","description":"Planned delivery date (YYYY-MM-DD)","format":"date","example":"2025-08-27"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"deliveryAddress":{"$ref":"#/components/schemas/deliveryAddress"},"deliveredQuantity":{"type":"number","description":"Quantity that has already been delivered for the purchase order line","example":55},"orderConfirmations":{"type":"array","items":{"$ref":"#/components/schemas/orderConfirmation"}},"externalPlannerId":{"type":"string","description":"External unique id of the responsible planner / dispatcher in the source system","example":"PLAN-4410-B"},"accountAssignmentType":{"type":"string","description":"Account assignment type of the purchase order line which defines the type of accounting object (e.g. cost center, asset, project) the costs of the line are assigned to","example":"K"},"conditions":{"type":"array","description":"Pricing conditions (surcharges, discounts, freight, ...) applied to the purchase order line, one entry per condition record","items":{"$ref":"#/components/schemas/purchaseOrderLineCondition"}}}}},"components/schemas/deliveryTerms":{"id":"components/schemas/deliveryTerms","kind":"json-schema","title":"deliveryTerms","data":{"type":"object","description":"Object containing delivery terms information as defined in the source system","properties":{"deliveryTermKey":{"type":"string","description":"Key of the delivery terms as defined in the source system (e.g. Incoterms or internal delivery condition codes)","example":"FOB"},"descriptions":{"type":"array","description":"Descriptions of the delivery terms in different languages","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Free on Board - Port of Los Angeles","language":"en"},{"text":"Franco a bordo - Puerto de Los Ángeles","language":"es"}]},"additionalInfo":{"type":"string","description":"Additional info on the delivery terms (e.g. port or packaging)","example":"Some additional info"}}}},"components/schemas/purchaseOrder":{"id":"components/schemas/purchaseOrder","kind":"json-schema","title":"purchaseOrder","data":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"External id of the purchase order that is globally unique across the provided purchase order data","example":"4500016221","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"purchaseOrderNumber":{"type":"string","description":"Number of the purchase order in the source system (not unique across clients)","example":"PoNumber123"},"createdDate":{"type":"string","description":"Date when the purchase order was created in the external system","format":"date","example":"2000-12-31"},"fiscalYearLabel":{"type":"string","description":"Label used in the source system for the fiscal year that the purchase order was created in","example":"2023"},"language":{"allOf":[{"$ref":"#/components/schemas/LanguageCode"},{"description":"Language assigned to the purchase order. If the source system allows for storing data of text fields in different languages, the data should be transferred to Hypatos in the language that is assigned to the purchase order (exception: for payment terms all languages should be transferred)."}]},"externalCompanyId":{"type":"string","description":"Company that the purchase order is assigned to","example":"DE01"},"type":{"description":"type of the purchase order as defined in the source system","type":"string","example":"Service"},"externalSupplierId":{"type":"string","description":"External unique id of the supplier in the source system","example":"0000100000"},"status":{"type":"string","description":"Status of purchase order as defined in source system","example":"OPEN"},"invoicingStatus":{"$ref":"#/components/schemas/invoicingStatus"},"deliveryStatus":{"$ref":"#/components/schemas/deliveryStatus"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totalNetAmount":{"type":"number","description":"Total net amount of purchase order (sum of line item net amounts)","example":81},"totalFreightCharges":{"type":"number","description":"Sum of all freight charges as defined on the purchase order","example":9},"totalOtherCharges":{"type":"number","description":"Sum of all charges other than freight charges as defined on the purchase order","example":10},"totalTaxAmount":{"type":"number","description":"Total tax amount of purchase order (sum of all taxes)","example":19},"totalGrossAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total gross amount of purchase order (total net amount + total freight charges + total other charges + total tax amount)"},"children":[]}]}]}],"example":119},"totalInvoicedNetAmount":{"type":"number","description":"Total net amount invoiced for this purchase order, calculated as the sum of the net amounts of all invoices posted against it","example":119},"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"purchaseOrderLines":{"type":"array","items":{"$ref":"#/components/schemas/purchaseOrderLine"}},"productNumber":{"type":"string","description":"Number of the product as defined by the purchaser","example":"123456789"},"externalPurchaserId":{"type":"string","description":"External unique id of the responsible purchaser in the source system","example":"PUR-88293-X"},"deliveryTerms":{"$ref":"#/components/schemas/deliveryTerms"}}}},"components/schemas/languagedTextWithValue":{"id":"components/schemas/languagedTextWithValue","kind":"json-schema","title":"languagedTextWithValue","data":{"type":"object","properties":{"value":{"type":"string","description":"Text Value","example":"OE"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/languagedText"}}}}},"components/schemas/glAccount":{"id":"components/schemas/glAccount","kind":"json-schema","title":"glAccount","data":{"type":"object","required":["externalId","code"],"properties":{"externalId":{"type":"string","description":"External id of the general ledger account that is globally unique across the provided general ledger account data","example":"0000100GL1","pattern":"^\\S([\\S ]*\\S)?$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the general ledger account in the source system (not unique across clients)","example":"GL1","pattern":"^\\S([\\S ]*\\S)?$"},"companyAssignment":{"type":"array","description":"List of externalCompanyIds that the approver is assigned to","example":["DE01","US01"],"items":{"type":"string"}},"type":{"$ref":"#/components/schemas/languagedTextWithValue"},"category":{"$ref":"#/components/schemas/languagedTextWithValue"},"label":{"type":"array","description":"Label describing the general ledger account","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Entertainment Expenses","language":"en"}]},"accountGroup":{"type":"object","properties":{"value":{"type":"string","description":"Alphanumeric value of the general ledger account group","example":"123"},"labels":{"type":"array","description":"Label describing the general ledger account","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Entertainment Expenses","language":"en"}]}}},"shortLabel":{"type":"array","description":"Short label describing the general ledger account","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Entertainment Exp.","language":"en"}]},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/costCenter":{"id":"components/schemas/costCenter","kind":"json-schema","title":"costCenter","data":{"type":"object","required":["externalId","code"],"properties":{"externalId":{"type":"string","description":"External id of the cost center that is globally unique across the provided cost center data","example":"0000100CO1","pattern":"^\\S([\\S ]*\\S)?$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the cost center in the source system (not unique across clients)","example":"CO1","pattern":"^\\S([\\S ]*\\S)?$"},"companyAssignment":{"type":"array","description":"List of externalCompanyIds that the approver is assigned to","example":["DE01","US01"],"items":{"type":"string"}},"type":{"$ref":"#/components/schemas/languagedTextWithValue"},"category":{"$ref":"#/components/schemas/languagedTextWithValue"},"label":{"type":"array","description":"Label describing the cost center","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Sales Engineers","language":"en"}]},"shortLabel":{"type":"array","description":"Short label describing the cost center","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Sales Eng.","language":"en"}]},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/approver":{"id":"components/schemas/approver","kind":"json-schema","title":"approver","data":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"External id of the approver that is globally unique across the provided approver data","example":"UserID#1234","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the approver in the source system (not unique across clients)","example":"CODE1"},"companyAssignment":{"type":"array","description":"List of externalCompanyIds that the approver is assigned to","example":["DE01","US01"],"items":{"type":"string"}},"isActive":{"type":"boolean","example":true},"firstName":{"type":"string","description":"First name of the approving person","example":"Koala"},"lastName":{"type":"string","description":"Last name of the approving person","example":"Hinze"},"email":{"type":"string","description":"Email address of the approving person","format":"email","example":"accountant@sap.com"},"phoneNumber":{"type":"string","description":"Phone number of the approving person","example":"+491001234567891"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/salesOrganizationInfo":{"id":"components/schemas/salesOrganizationInfo","kind":"json-schema","title":"salesOrganizationInfo","data":{"type":"object","description":"Details of the associated sales organization","properties":{"externalSalesOrganizationId":{"type":"string","description":"External identifier for the sales organization","example":"1000"},"distributionChannel":{"type":"string","description":"Distribution channel for sales","example":"2000"},"division":{"type":"string","description":"Division under which the sales organization operates","example":"3000"},"salesGroup":{"type":"string","description":"Sales group associated with the contract","example":"4000"},"salesOffice":{"type":"string","description":"Sales office responsible for the contract","example":"5000"},"blockedForOrdering":{"type":"boolean","description":"Indicator if the customer is blocked for ordering in a sales organization","example":true},"blockedForDelivery":{"type":"boolean","description":"Indicator if the subsidiary is blocked for delivery","example":false},"shippingAddresses":{"type":"array","description":"List of external id of the related shipping addresses","example":["ADDR001","ADDR002"],"items":{"type":"string"}},"billingAddresses":{"type":"array","description":"List of external id of the related billing addresses","example":["ADDR003"],"items":{"type":"string"}},"salesOrganizationCode":{"type":"string","description":"Code of the sales organization in the source system (not unique across clients)","example":"SO001"},"salesUnit":{"type":"object","properties":{"unitOfMeasure":{"type":"string","description":"Unit in which the product is sold, different from base unit","example":"PK"},"conversionFactorToBaseUnit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversion factor for converting a quantity in sales unit to a quantity in base unit. For example, if the base unit is kg, the sales unit is PK, and the conversion factor is 1000, then 1 PK = 1000 kg."},"children":[]}]}]}],"example":1000},"description":{"type":"string","description":"Description of the sales unit packaging","example":"Package of 10 units"}}}}}},"components/schemas/customerSalesOrganizationInfo":{"id":"components/schemas/customerSalesOrganizationInfo","kind":"json-schema","title":"customerSalesOrganizationInfo","data":{"description":"Details of the sales organization associated with the customer","allOf":[{"$ref":"#/components/schemas/salesOrganizationInfo"},{"type":"object","properties":{"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"customerGroup1":{"type":"string","description":"Customer group 1 as defined in the source system","example":"01"},"customerGroup2":{"type":"string","description":"Customer group 2 as defined in the source system","example":"02"},"customerGroup3":{"type":"string","description":"Customer group 3 as defined in the source system","example":"03"},"customerGroup4":{"type":"string","description":"Customer group 4 as defined in the source system","example":"04"},"customerGroup5":{"type":"string","description":"Customer group 5 as defined in the source system","example":"05"}}}]}},"components/schemas/customer":{"id":"components/schemas/customer","kind":"json-schema","title":"customer","data":{"type":"object","required":["name","externalId"],"properties":{"externalId":{"type":"string","description":"External id of the customer that is globally unique across the provided customer data","example":"0000100000","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the customer in the source system (not unique across clients)","example":"CODE1"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type (role) of the customer as defined in the source system (e.g. SOLD_TO, SHIP_TO, BILL_TO, PAYER)"},"children":[]}]}]}],"example":"SOLD_TO"},"name":{"type":"string","description":"Name of the customer","example":"Acmne Corp.","pattern":"^[\\S ]*\\S[\\S ]*$"},"nameAlternative1":{"type":"string","description":"Alternative name of the customer","example":"Acmne Corp."},"nameAlternative2":{"type":"string","description":"Alternative name of the customer","example":"Acmne Corp."},"nameAlternative3":{"type":"string","description":"Alternative name of the customer","example":"Acmne Corp."},"nameAlternative4":{"type":"string","description":"Alternative name of the customer","example":"Acmne Corp."},"street":{"type":"string","description":"Street and street number where the customer is located","example":"Hauptstr. 1"},"addressAdditional":{"type":"string","description":"Additional address data (e.g. apartment or suite)","example":"Eingang B"},"postcode":{"type":"string","description":"Postcode where the customer is located","example":"10001"},"city":{"type":"string","description":"City where the customer is located","example":"Berlin"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"vatIds":{"type":"array","description":"List of VAT IDs assigned to the customer","example":[{"id":"DE123456789","countryCode":"DE"}],"items":{"$ref":"#/components/schemas/vatId"}},"taxIds":{"type":"array","description":"List of Tax IDs assigned to the customer","example":[{"id":"123-456-789","type":"TIN"}],"items":{"$ref":"#/components/schemas/taxId"}},"blockedForPosting":{"type":"boolean","description":"Indicator if the customer is blocked for posting","example":false},"blockedForPayment":{"type":"boolean","description":"Indicator if the customer is blocked for payment","example":false},"blockedForOrdering":{"type":"boolean","description":"Indicator if the customer is blocked for ordering globally","example":false},"blockedForDelivery":{"type":"boolean","description":"Indicator if the customer is blocked for delivery globally","example":false},"globalLocationNumber":{"type":"string","description":"13-digit Global Location Number (GLN) used for unique location identification in B2B transactions","example":"4000001000002"},"duns":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D-U-N-S Number issued by Dun & Bradstreet. A globally used identifier for business entities."},"children":[]}]}]}],"example":"123456789"},"customerSubsidiaries":{"type":"array","items":{"$ref":"#/components/schemas/subsidiary"}},"customerBankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/bankAccount"}},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"salesOrganizationInfo":{"type":"array","items":{"$ref":"#/components/schemas/customerSalesOrganizationInfo"}}}}},"components/schemas/lookup-table-row":{"id":"components/schemas/lookup-table-row","kind":"json-schema","title":"lookup-table-row","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Row of a customer-defined lookup table. Names reserved by the search index that the rows are published to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_doc_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_field_names"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_ignored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_nested_path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_routing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_seq_no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must not be used as property names and are rejected."},"children":[]}]}]}],"required":["externalId"],"properties":{"externalId":{"type":"string","description":"External id of the lookup-table-row that is globally unique across the provided lookup-table-row data"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Number of the lookup table record in the source system (not unique across clients)","example":"CODE1"}},"additionalProperties":{"type":"string","maxProperties":20,"description":"externalClientId and code counts for maximum 20 additional properties"},"example":{"externalId":"12345","externalClientId":"EXTERNAL_CLIENT_ID","dimension1":"someValue","dimension2":"anotherValue","customField":"dynamicValue"}}},"components/schemas/contractStatus":{"id":"components/schemas/contractStatus","kind":"json-schema","title":"contractStatus","data":{"type":"string","nullable":true,"description":"Indicates the current lifecycle state of the contract","example":"active","enum":["draft","active","pending","suspended","cancelled","expired","terminated",null],"x-enum-descriptions":["The contract is in draft mode and has not been finalized. It can still be edited","The contract is currently in effect and legally binding","The contract has been submitted for approval or is awaiting finalization","The contract is temporarily on hold but not yet terminated","The contract has been cancelled before becoming active","The contract has reached its end date and is no longer valid","The contract was ended before its expiration date"]}},"components/schemas/businessPartnerType":{"id":"components/schemas/businessPartnerType","kind":"json-schema","title":"businessPartnerType","data":{"type":"string","nullable":true,"description":"Type of business partner (e.g., Supplier, Customer)","example":"supplier","enum":["supplier","customer",null]}},"components/schemas/businessPartner":{"id":"components/schemas/businessPartner","kind":"json-schema","title":"businessPartner","data":{"type":"object","description":"Details of the business partner associated with the contract","properties":{"externalId":{"type":"string","description":"External id of the business partner that is globally unique across the provided business partner data","example":"0000100000"},"type":{"$ref":"#/components/schemas/businessPartnerType"}}}},"components/schemas/parentContract":{"id":"components/schemas/parentContract","kind":"json-schema","title":"parentContract","data":{"type":"object","description":"Details of the business partner associated with the contract","properties":{"externalId":{"type":"string","description":"External id of the parent contract that is globally unique across the provided parent contract data","example":"PARENT-2024-0005"},"contractNumber":{"type":"string","description":"Contract number of the parent contract","example":"CN-2024-005"}}}},"components/schemas/contractItem":{"id":"components/schemas/contractItem","kind":"json-schema","title":"contractItem","data":{"type":"object","properties":{"itemNumber":{"type":"string","description":"Unique identifier for the contract item","example":"001"},"category":{"type":"string","description":"Category of the contract item (e.g., Service, Product)","example":"Service"},"description":{"type":"string","description":"Description of the contract item","example":"Annual software maintenance"},"netAmount":{"type":"number","description":"Net amount of the contract item","example":25000},"taxAmount":{"type":"number","description":"Tax amount applicable to the contract item","example":4750},"grossAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gross amount of the contract item (net + tax)"},"children":[]}]}]}],"example":29750},"unitPrice":{"type":"number","description":"Price per unit of the contract item","example":25000},"quantity":{"type":"number","description":"Quantity of the contract item","example":1},"unitOfMeasure":{"type":"string","description":"Unit of measure for the contract item","example":"EA"},"billingCycle":{"type":"string","description":"Purchase order related to the invoice line item","example":"Billing cycle for the contract item"},"durationMonths":{"type":"number","description":"Duration of the contract item in months","example":12},"taxCode":{"$ref":"#/components/schemas/taxCode"}}}},"components/schemas/additionalAgreement":{"id":"components/schemas/additionalAgreement","kind":"json-schema","title":"additionalAgreement","data":{"type":"object","properties":{"externalId":{"type":"string","description":"External id of the agreement that is globally unique across the provided agreement data","example":"AGREEMENT-001"},"type":{"type":"string","description":"Type of agreement","example":"downPaymentAllowed"},"value":{"type":"boolean","description":"Value of the agreement condition","example":true}}}},"components/schemas/obligation":{"id":"components/schemas/obligation","kind":"json-schema","title":"obligation","data":{"type":"object","properties":{"party":{"type":"string","description":"Party responsible for the obligation","example":"Company A"},"description":{"type":"string","description":"Description of the obligation","example":"Company A will deliver 1000 units of Product X per quarter"}}}},"components/schemas/contactItem":{"id":"components/schemas/contactItem","kind":"json-schema","title":"contactItem","data":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the contact person","example":"Koala"},"lastName":{"type":"string","description":"Last name of the contact person","example":"Hinze"},"email":{"type":"string","description":"Email address of the contact person","example":"accountant@sap.com"},"phoneNumber":{"type":"number","description":"Phone number of the contact person","example":491001234567891}}}},"components/schemas/contract":{"id":"components/schemas/contract","kind":"json-schema","title":"contract","data":{"required":["externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External id of the contract that is globally unique across the provided contract data","example":"CONTRACT-2025-0001","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"CONTRACT-2025-0001"},"documentId":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"67c02594d4aa80eecbd39bbe","pattern":"^[0-9a-fA-F]{24}$"},"documents":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/document"}},"contractNumber":{"type":"string","description":"Contract number assigned in the source system","example":"CN-2025-001"},"status":{"$ref":"#/components/schemas/contractStatus"},"businessPartnerContractNumber":{"type":"string","description":"Contract number assigned by the business partner","example":"K9120-12"},"externalCompanyId":{"type":"string","description":"External unique identifier of the company in the source system","example":"DE01"},"salesOrganizationInfo":{"type":"array","items":{"$ref":"#/components/schemas/salesOrganizationInfo"}},"businessPartner":{"$ref":"#/components/schemas/businessPartner"},"title":{"type":"string","description":"Title or name of the contract","example":"Software Maintenance Agreement"},"description":{"type":"string","description":"Description of the contract and its purpose","example":"Annual software maintenance contract for Acme Corp"},"createdDate":{"type":"string","description":"Date when the contract was created (YYYY-MM-DD)","format":"date","example":"2025-01-15"},"startDate":{"type":"string","description":"Date when the contract becomes effective (YYYY-MM-DD)","format":"date","example":"2025-02-01"},"endDate":{"type":"string","description":"Date when the contract expires (YYYY-MM-DD)","format":"date","example":"2026-01-31"},"fiscalYearLabel":{"type":"string","description":"Fiscal year label associated with the contract","example":"2023"},"type":{"type":"string","description":"Type of contract","example":"Service Agreement"},"subType":{"type":"string","description":"Subtype of contract","example":"Quantity"},"currency":{"type":"string","description":"Currency in which the contract amounts are denominated","example":"EUR"},"totalNetAmount":{"type":"number","description":"Total net amount of the contract","example":50000},"totalTaxAmount":{"type":"number","description":"Total tax amount applicable to the contract","example":9500},"totalGrossAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total gross amount of the contract (net amount + tax)"},"children":[]}]}]}],"example":59500},"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"parentContract":{"$ref":"#/components/schemas/parentContract"},"targetQuantity":{"type":"number","description":"Target quantity specified in the contract","example":1000},"targetValue":{"type":"number","description":"Target value of the contract in the specified currency","example":200000},"contractItems":{"type":"array","description":"List of items included in the contract","items":{"$ref":"#/components/schemas/contractItem"}},"additionalAgreements":{"type":"array","description":"List of additional agreements linked to the contract","items":{"$ref":"#/components/schemas/additionalAgreement"}},"obligations":{"type":"array","description":"List of obligations specified in the contract","items":{"$ref":"#/components/schemas/obligation"}},"contacts":{"type":"array","description":"List of contact persons associated with the contract","items":{"$ref":"#/components/schemas/contactItem"}},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/salesOrderLine":{"id":"components/schemas/salesOrderLine","kind":"json-schema","title":"salesOrderLine","data":{"type":"object","properties":{"plannedDeliveryDate":{"type":"string","description":"Planned delivery date (YYYY-MM-DD)","format":"date","example":"2025-08-27"},"orderLineNumber":{"type":"string","description":"External unique id of the sales order line in the source system","example":"00000001"},"externalCompanyId":{"type":"string","description":"Company that the sales order is assigned to","example":"DE01"},"externalProductId":{"type":"string","description":"External unique id of the product in the source system","example":"PO01"},"quantity":{"type":"number","description":"Ordered quantity of the sales order line","example":2},"unitOfMeasure":{"type":"string","description":"Unit of measure of the sales order line","example":"kg"},"unitPrice":{"type":"number","description":"Unit price of the sales order line","example":100},"netAmount":{"type":"number","description":"Net amount of the sales order line","example":200},"totalTaxAmount":{"type":"number","description":"Tax amount of the sales order line","example":38},"grossAmount":{"type":"number","description":"Gross amount of the sales order line","example":238},"taxCode":{"$ref":"#/components/schemas/taxCode"},"description":{"type":"string","description":"Description of the type of tax in the source system","example":"DEU - Standard (19%)"},"plant":{"type":"string","description":"Plant responsible for fulfilling the sales order line","example":"PLANT-001"},"storageLocation":{"type":"string","description":"Storage location of the sales order line","example":"BOX-001"},"externalShippingAddressId":{"type":"string","description":"Shipping address for the sales order line","example":"DE-123E"},"externalBillingAddressId":{"type":"string","description":"Billing address related to the sales order line","example":"DE-123E"},"itemText":{"type":"string","description":"Text describing the sales order line","example":"Sold item ABC"},"type":{"type":"string","description":"Type of the sales order line","example":"Item type"},"externalQuoteId":{"type":"string","description":"Quote that the sales order line was ordered from","example":"EQ01"},"quoteLineNumber":{"type":"string","description":"Line number from the linked quote","example":"LN01"},"externalContractId":{"type":"string","description":"Contract that the sales order line is related to","example":"ECID01"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/salesOrder":{"id":"components/schemas/salesOrder","kind":"json-schema","title":"salesOrder","data":{"required":["externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External id of the sales order that is globally unique across the provided sales order data","example":"DE01","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"documentId":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"63cac12c37bb02accb396cae","pattern":"^[0-9a-fA-F]{24}$"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"}},"customerOrderNumber":{"type":"string","description":"Sales order number provided by the issuing customer","example":"CUSTOMER_ORDER_NUMBER"},"salesOrderNumber":{"type":"string","description":"Number of the sales order in the source system (not unique across clients)","example":"SALES_ORDER_NUMBER"},"externalCompanyId":{"type":"string","description":"External unique id of the company in the source system","example":"DE01"},"externalCustomerId":{"type":"string","description":"External unique id of the customer in the source system","example":"CO01"},"salesOrganizationCode":{"type":"string","description":"Sales organization code","example":"SO001"},"distributionChannel":{"type":"string","description":"Distribution channel code","example":"CH1"},"division":{"type":"string","description":"Division code","example":"DIV01"},"salesGroup":{"type":"string","description":"Sales group responsible for the order","example":"123456"},"salesOffice":{"type":"string","description":"Sales office responsible for the order","example":"98765"},"type":{"type":"string","description":"Type of the invoice as defined in the source system","example":"OR"},"subType":{"type":"string","description":"Sub type of the invoice as defined in the source system","example":"recurring"},"issuedDate":{"type":"string","description":"Date when the invoice was issued by the supplier (printed on invoice document)","format":"date","example":"2000-12-31"},"receivedDate":{"type":"string","description":"Date when the invoice was received by the company","format":"date","example":"2000-12-31"},"fiscalYearLabel":{"type":"string","description":"Label used in the source system for the fiscal year that the invoice was posted in","example":"2023"},"requestedDeliveryDate":{"type":"string","description":"Requested delivery date","format":"date","example":"2000-12-31"},"isCanceled":{"type":"boolean","description":"Indicator if the invoice is canceled","example":false},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totalNetAmount":{"type":"number","description":"Total net amount of sales order (sum of line item net amounts)","example":100},"totalTaxAmount":{"type":"number","description":"Total tax amount of sales order (sum of all taxes)","example":19},"totalGrossAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total gross amount of sales order (total net amount + total tax amount)"},"children":[]}]}]}],"example":119},"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"headerText":{"type":"string","description":"Header Text describing the invoice","example":"doc header text"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"salesOrderLines":{"type":"array","items":{"$ref":"#/components/schemas/salesOrderLine"}}}}},"components/schemas/productSalesOrganizationInfo":{"id":"components/schemas/productSalesOrganizationInfo","kind":"json-schema","title":"productSalesOrganizationInfo","data":{"description":"Details of the sales organization associated with the product","allOf":[{"$ref":"#/components/schemas/salesOrganizationInfo"},{"type":"object","properties":{"productGroup1":{"type":"string","description":"Customer- or ERP-defined sales product classification 1. Can be used for reporting, pricing, segmentation, routing, or sales-specific product grouping.","example":"ELECTRONICS"},"productGroup2":{"type":"string","description":"Customer- or ERP-defined sales product classification 2. Can be used for reporting, pricing, segmentation, routing, or sales-specific product grouping.","example":"COMPUTERS"},"productGroup3":{"type":"string","description":"Customer- or ERP-defined sales product classification 3. Can be used for reporting, pricing, segmentation, routing, or sales-specific product grouping.","example":"LAPTOPS"},"productGroup4":{"type":"string","description":"Customer- or ERP-defined sales product classification 4. Can be used for reporting, pricing, segmentation, routing, or sales-specific product grouping.","example":"B2B_DIRECT"},"productGroup5":{"type":"string","description":"Customer- or ERP-defined sales product classification 5. Can be used for reporting, pricing, segmentation, routing, or sales-specific product grouping.","example":"B2B_DIRECT"},"productCategoryGroup":{"type":"string","description":"Sales-specific product category or item category group used to determine how the product is handled in sales processes, such as order processing, item categorization, pricing, or fulfillment logic.","example":"STANDARD_GOOD"}}}]}},"components/schemas/product":{"id":"components/schemas/product","kind":"json-schema","title":"product","data":{"required":["externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External ID of the product that is globally unique across the provided product data","example":"DE01","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"productNumber":{"type":"string","description":"Number of the product as defined by the supplier","example":"NO123"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the product as defined in the company’s product master (e.g., Operating Supplies)"},"children":[]}]}]}],"example":"Operating Supplies"},"group":{"type":"string","description":"Group of the product as defined in the product master of the company","example":"Electronics"},"description":{"type":"string","description":"Description of the product","example":"A Laptop XP"},"shortDescription":{"type":"string","description":"Shortened version of the product description","example":"A great laptop"},"manufacturer":{"type":"string","description":"Name of the product manufacturer","example":"Corporation ABC"},"unspsc":{"type":"string","description":"Universal Product Code (UPC-A)","example":"43211508"},"ean":{"type":"string","description":"European Article Number (EAN-13)","example":"4006381333931"},"upc":{"type":"string","description":"Universal Product Code (UPC-A)","example":"036000291452"},"gtin":{"type":"string","description":"Global Trade Item Number (GTIN) according to GS1 standards. A globally unique identifier for trade items and products.","example":"4006381333931"},"baseUnitOfMeasure":{"type":"string","description":"The base unit in which the product is managed in the system","example":"kg"},"customsTariffNumber":{"type":"string","description":"Customs tariff number (HS/TARIC code) used for cross-border trade and customs","example":"8471300000"},"plants":{"type":"array","items":{"type":"string","description":"Identifier of the plants where the product is stored or managed","example":"PLANT-001"}},"status":{"type":"string","description":"Current status of the product","example":"ACTIVE","enum":["ACTIVE","INACTIVE","DISCONTINUED"]},"grossWeight":{"type":"number","description":"Gross weight of the product including packaging","example":2.5},"netWeight":{"type":"number","description":"Net weight of the product excluding packaging","example":2.3},"weightUnit":{"type":"string","description":"Unit for weight values","example":"KG"},"volume":{"type":"number","description":"Volume of the product","example":0.015},"volumeUnit":{"type":"string","description":"Unit for volume values","example":"M3"},"salesOrganizationInfo":{"type":"array","items":{"$ref":"#/components/schemas/productSalesOrganizationInfo"}},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/customerProduct":{"id":"components/schemas/customerProduct","kind":"json-schema","title":"customerProduct","data":{"required":["externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External id of the customer product that is globally unique across the provided customer product data","example":"DE01-1000004711-CUST-ABC-4711","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"externalCustomerId":{"type":"string","description":"External unique id of the customer in the source system","example":"1000004711"},"externalProductId":{"type":"string","description":"Unique id of the product in the source system that links the customer product to the internal product master","example":"DE01-MAT-000123"},"customerProductNumber":{"type":"string","description":"Product number used by the customer to identify the product","example":"CUST-ABC-4711"},"unspsc":{"type":"string","description":"United Nations Standard Products and Services Code of the product","example":"43211508"},"ean":{"type":"string","description":"European Article Number (EAN-13)","example":"4006381333931"},"upc":{"type":"string","description":"Universal Product Code (UPC-A)","example":"036000291452"},"gtin":{"type":"string","description":"Global Trade Item Number (GTIN) according to GS1 standards. A globally unique identifier for trade items and products.","example":"4006381333931"},"customsTariffNumber":{"type":"string","description":"Customs tariff number (HS/TARIC code) used for cross-border trade and customs","example":"8471300000"},"customerProductDescription":{"type":"string","description":"Product description used by the customer","example":"Laptop 14 inch business model"},"salesOrganizationCode":{"type":"string","description":"Sales organization for which the customer product is valid","example":"DE01"},"distributionChannel":{"type":"string","description":"Distribution channel for sales","example":"10"},"division":{"type":"string","description":"Division under which the sales organization operates","example":"00"},"baseUnitOfMeasure":{"type":"string","description":"The base unit in which the product is managed in the system","example":"kg"},"status":{"type":"string","description":"Current status of the customer product","example":"ACTIVE"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/address":{"id":"components/schemas/address","kind":"json-schema","title":"address","data":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"External id of the address that is globally unique across the provided address data","pattern":"^\\S+$","example":"ADDR12345"},"businessPartnerNumber":{"type":"string","description":"Number of the business partner related to this address (e.g. customer number)","example":"BP12345"},"parentBusinessPartnerNumber":{"type":"string","description":"Number of the parent business partner of this address (e.g. customer number)","example":"PBP12345"},"type":{"type":"string","description":"Type of the address","enum":["shippingAddress","billingAddress"],"example":"shippingAddress"},"addressOrder":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order of the address (in case there’s several addresses of the same type)"},"children":[]}]}]}],"example":1},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"CLIENT123"},"globalLocationNumber":{"type":"string","description":"13-digit Global Location Number (GLN) used for unique location identification in B2B transactions","example":"1234567890123"},"companyName":{"type":"string","description":"Name of the company associated with the address","pattern":"^[\\S ]*\\S[\\S ]*$","example":"Acme Corporation"},"nameAlternative1":{"type":"string","description":"Alternative name of the company (e.g. trade name or local language)","example":"Acme Corp."},"nameAlternative2":{"type":"string","description":"Alternative name of the company","example":"Acme Inc."},"nameAlternative3":{"type":"string","description":"Alternative name of the company","example":"Acme Ltd."},"nameAlternative4":{"type":"string","description":"Alternative name of the company","example":"Acme GmbH"},"street":{"type":"string","description":"Street and street number where the address is located","example":"123 Main St"},"addressAdditional":{"type":"string","description":"Additional address data (e.g. building, entrance, apartment, or suite)","example":"Building A, Suite 101"},"postcode":{"type":"string","description":"Postcode where the address is located","example":"12345"},"city":{"type":"string","description":"City where the address is located","example":"Berlin"},"postOfficeBox":{"type":"string","description":"Post office box number, if used instead of street address","example":"PO Box 123"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"region":{"type":"string","description":"Region, state, or province of the address (e.g. \"CA\" for California or \"BE\" for Berlin)","example":"BE"},"transportationZone":{"type":"string","description":"Code identifying the transportation or logistics zone relevant for shipping or route planning","example":"TZ123"},"phoneNumber":{"type":"string","description":"Phone number of the location or contact point","example":"+491234567890"},"faxNumber":{"type":"string","description":"Fax number of the location or contact point","example":"+491234567891"},"email":{"type":"string","description":"Email address associated with the location or contact point","example":"contact@acme.com"},"validFrom":{"type":"string","format":"date","description":"Start date from which the address is considered valid (format: YYYY-MM-DD)","example":"2023-01-01"},"validTo":{"type":"string","format":"date","description":"End date until which the address is considered valid (format: YYYY-MM-DD)","example":"2023-12-31"},"isDefault":{"type":"boolean","description":"Indicator whether this address is the default for the given type (e.g., default ship-to address)","example":true},"latitude":{"type":"number","description":"Geographical latitude coordinate of the address (in decimal degrees)","example":52.520008},"longitude":{"type":"number","description":"Geographical longitude coordinate of the address (in decimal degrees)","example":13.404954},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/quote":{"id":"components/schemas/quote","kind":"json-schema","title":"quote","data":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","pattern":"^\\S+$","description":"External id of the sales order that is globally unique across the provided sales order data","example":"QUOTE12345"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"CLIENT123"},"documentId":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"DOC12345"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"DOC12345"},"type":{"type":"string","description":"Document type that was assigned during upload to Hypatos","example":"invoice"}}}},"quoteNumber":{"type":"string","description":"Quote number from the source system","example":"Q12345"},"customerOrderNumber":{"type":"string","description":"Customer order number the quote refers to","example":"CO12345"},"externalCompanyId":{"type":"string","description":"External unique id of the company in the source system","example":"COMP123"},"externalCustomerId":{"type":"string","description":"External unique id of the customer in the source system","example":"CUST123"},"status":{"type":"string","description":"Status of the quote","example":"approved"},"salesOrganizationCode":{"type":"string","description":"Sales organization code","example":"SO123"},"distributionChannel":{"type":"string","description":"Distribution channel code","example":"DC123"},"division":{"type":"string","description":"Division code","example":"DIV123"},"salesGroup":{"type":"string","description":"Sales group responsible for the quote","example":"123"},"salesOffice":{"type":"string","description":"Sales office responsible for the quote","example":"456"},"type":{"type":"string","description":"Type of the quote as defined in the source system","example":"standard"},"subType":{"type":"string","description":"Sub-type of the quote as defined in the source system","example":"recurring"},"issuedDate":{"type":"string","format":"date","description":"Date when the quote was issued","example":"2023-01-01"},"validUntilDate":{"type":"string","format":"date","description":"Date until the quote is valid","example":"2023-12-31"},"fiscalYearLabel":{"type":"string","description":"Fiscal year label used in the source system","example":"FY2023"},"isCanceled":{"type":"boolean","description":"Indicator if the quote is canceled","example":false},"currency":{"type":"string","description":"Three letter currency code as defined in ISO 4217","example":"USD"},"totalNetAmount":{"type":"number","description":"Total net amount of the quote","example":1000},"totalTaxAmount":{"type":"number","description":"Total tax amount of the quote","example":190},"totalGrossAmount":{"type":"number","description":"Total gross amount of the quote","example":1190},"paymentTerms":{"$ref":"#/components/schemas/paymentTerms"},"headerText":{"type":"string","description":"Header text describing the quote","example":"This is a sample quote."},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"quoteLines":{"type":"array","items":{"type":"object","properties":{"quoteLineNumber":{"type":"string","description":"Quote line number","example":"QL12345"},"externalCompanyId":{"type":"string","description":"Company the quote line is assigned to","example":"COMP123"},"product":{"type":"object","properties":{"externalId":{"type":"string","description":"External ID of the quoted product","example":"PROD123"},"productNumber":{"type":"string","description":"Product number","example":"PN123"},"customerProductNumber":{"type":"string","description":"Customer-specific product number","example":"CPN123"},"type":{"type":"string","description":"Product type","example":"standard"},"group":{"type":"string","description":"Product group","example":"electronics"},"description":{"type":"string","description":"Product description","example":"A high-quality electronic product."},"manufacturer":{"type":"string","description":"Manufacturer of the product","example":"Acme Corp."},"manufacturerNumber":{"type":"string","description":"Manufacturer-specific number","example":"MN123"},"unspsc":{"type":"string","description":"UNSPSC classification code","example":"43211508"},"ean":{"type":"string","description":"European Article Number (EAN-13)","example":"4006381333931"},"upc":{"type":"string","description":"Universal Product Code (UPC-A)","example":"036000291452"}}},"status":{"type":"string","description":"Status of the quote line","example":"approved"},"quantity":{"type":"number","description":"Quoted quantity","example":10},"unitOfMeasure":{"type":"string","description":"Unit of measure","example":"kg"},"unitPrice":{"type":"number","description":"Unit price","example":100},"netAmount":{"type":"number","description":"Net amount of the quote line","example":1000},"totalTaxAmount":{"type":"number","description":"Tax amount of the quote line","example":190},"grossAmount":{"type":"number","description":"Gross amount of the quote line","example":1190},"taxCode":{"$ref":"#/components/schemas/taxCode"},"description":{"type":"string","description":"Quote line description","example":"This is a sample quote line."},"plant":{"type":"string","description":"Plant code","example":"PLANT123"},"storageLocation":{"type":"string","description":"Storage location","example":"LOC123"},"externalShippingAddressId":{"type":"string","description":"External shipping address ID","example":"ADDR123"},"externalBillingAddressId":{"type":"string","description":"External billing address ID","example":"ADDR456"},"itemText":{"type":"string","description":"Text describing the quote item","example":"Sample item text."},"type":{"type":"string","description":"Type of the quote item","example":"standard"},"externalContractId":{"type":"string","description":"Related external contract ID","example":"CONTRACT123"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}}}}},"components/schemas/goodsReceiptLine":{"id":"components/schemas/goodsReceiptLine","kind":"json-schema","title":"goodsReceiptLine","data":{"type":"object","description":"Represents a single line item within a goods receipt.","properties":{"goodsReceiptLineNumber":{"type":"string","description":"Number of the goods receipt line (unique within the purchase order)","example":"GRLINE-0001"},"externalCompanyId":{"type":"string","description":"Company ID associated with the line item.","example":"DE01"},"externalPurchaseOrderId":{"type":"string","description":"ID of the related purchase order.","example":"4500016221"},"purchaseOrderLineNumber":{"type":"string","description":"Line number of the purchase order being received.","example":"00010"},"type":{"type":"string","description":"Type of item received (e.g., Material, Service).","example":"Service"},"quantity":{"type":"number","format":"double","description":"Quantity of items received.","example":2},"unitOfMeasure":{"type":"string","description":"Unit of measure for the quantity.","example":"kg"},"itemText":{"type":"string","description":"Descriptive text for the line item.","example":"Dell Laptop Latitude D630"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of goods receipt line as defined in source system (e.g. “invoiced” or “open”)"},"children":[]}]}]}],"example":"invoiced"},"material":{"$ref":"#/components/schemas/material"},"plant":{"type":"string","description":"Receiving plant or location.","example":"PLANT-001"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/goodsReceipt":{"id":"components/schemas/goodsReceipt","kind":"json-schema","title":"goodsReceipt","data":{"type":"object","required":["externalId","goodsReceiptLines"],"properties":{"externalId":{"type":"string","description":"External id of the goods receipt that is globally unique across the provided goods receipt data","example":"GOODS_RECEIPT-0001","pattern":"^\\S+$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"documentId":{"type":"string","description":"Document id that was assigned during upload to Hypatos","example":"63cac12c37bb02accb396cbf","pattern":"^[0-9a-fA-F]{24}$"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"}},"goodsReceiptNumber":{"type":"string","description":"Goods receipt number provided in the source system","example":"GR123456789"},"externalCompanyId":{"type":"string","description":"External unique id of the company in the source system","example":"DE01"},"externalSupplierId":{"type":"string","description":"External unique id of the supplier in the source system","example":"0000100000"},"fiscalYearLabel":{"type":"string","description":"Label used in the source system for the fiscal year that the goods receipt was posted in","example":"2023"},"issuedDate":{"type":"string","description":"Date when the good receipt document was issued","format":"date","example":"2024-12-31"},"createdDate":{"type":"string","description":"Date when the goods receipt was created in the source system","format":"date","example":"2025-06-30"},"postingDate":{"type":"string","description":"Date when the goods receipt was posted","format":"date","example":"2025-06-30"},"headerText":{"type":"string","description":"Header text describing the goods receipt","example":"doc header text"},"status":{"type":"string","description":"Status of the goods receipt as defined in the source system","example":"POSTED"},"deliveryNoteNumber":{"type":"string","description":"Delivery note number associated with the goods receipt","example":"DN789456123"},"isReversal":{"type":"boolean","description":"Indicator if the goods receipt is a reversal","example":false},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"},"goodsReceiptLines":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/goodsReceiptLine"}}}}},"components/schemas/profitCenter":{"id":"components/schemas/profitCenter","kind":"json-schema","title":"profitCenter","data":{"type":"object","required":["externalId","code"],"properties":{"externalId":{"type":"string","description":"External id of the profit center that is globally unique across the provided profit center data","example":"0000100CO1","pattern":"^\\S([\\S ]*\\S)?$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"EXTERNAL_CLIENT_ID"},"code":{"type":"string","description":"Code of the profit center in the source system (not unique across clients)","example":"CO1","pattern":"^\\S([\\S ]*\\S)?$"},"companyAssignment":{"type":"array","description":"List of externalCompanyIds that the profit center is assigned to","example":["DE01","US01"],"items":{"type":"string"}},"department":{"type":"string","description":"Department/functional area associated with the profit center as defined in the source system","example":"finance"},"label":{"type":"array","description":"Label describing the profit center","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Sales Engineers","language":"en"}]},"shortLabel":{"type":"array","description":"Short label describing the profit center","items":{"$ref":"#/components/schemas/languagedText"},"example":[{"text":"Sales Eng.","language":"en"}]},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/internalOrder":{"id":"components/schemas/internalOrder","kind":"json-schema","title":"internalOrder","data":{"type":"object","required":["externalId","internalOrderCode"],"properties":{"externalId":{"type":"string","description":"External id of the internal order that is globally unique across the provided order data","example":"SAP:AUFK:000300123456","pattern":"^\\S([\\S ]*\\S)?$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"100"},"internalOrderCode":{"type":"string","description":"Internal order code/number from the source system (not unique across clients)","example":"000300123456","pattern":"^\\S([\\S ]*\\S)?$"},"internalOrderReferenceNumber":{"type":"string","description":"Additional internal order reference number from the source system","example":"ABC1234"},"createdDate":{"type":"string","description":"Date when the internal order record was created in the source system (YYYY-MM-DD)","format":"date","example":"2025-02-10"},"fiscalYearLabel":{"type":"string","description":"Label used in the source system for the fiscal year relevant to the internal order","example":"2023"},"language":{"$ref":"#/components/schemas/LanguageCode"},"externalCompanyId":{"type":"string","description":"External unique id of the company in the source system.","example":"DE01"},"status":{"type":"string","description":"Lifecycle status of the internal order","example":"OPEN"},"type":{"type":"string","description":"Order type/category as defined in the source system","example":"overhead"},"subType":{"type":"string","description":"Sub-classification of the internal order as defined in the source system","example":"category"},"description":{"type":"string","description":"Long description of the internal order","example":"Marketing campaign Q2 2025 – brand awareness and lead generation"},"shortDescription":{"type":"string","description":"Short description used in UIs and search","example":"MKT Q2/2025"},"profitCenterCode":{"type":"string","description":"Assigned profit center code","example":"PC4100"},"costCenterCodeForSettlement":{"type":"string","description":"Default receiver cost center used when settling the internal order (if applicable)","example":"CC4105"},"glAccountCodeForSettlement":{"type":"string","description":"Default G/L account (or cost element) used for settlement postings where relevant","example":"GL3094"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/project":{"id":"components/schemas/project","kind":"json-schema","title":"project","data":{"type":"object","required":["externalId","code"],"properties":{"externalId":{"type":"string","description":"External id of the project that is globally unique across the provided project data","example":"SAP:PRPS:0000123456","pattern":"^\\S([\\S ]*\\S)?$"},"externalClientId":{"type":"string","description":"Identifier of the client entity in the source system which can be used to separate data","example":"100"},"code":{"type":"string","description":"Code of the project in the source system (not unique across clients)","example":"PROJ1234"},"projectReferenceNumber":{"type":"string","description":"Use for converted WBS Element number","example":"PRJ-2025-BER-GRID"},"createdDate":{"type":"string","description":"Date when the project was created","format":"date","example":"2025-01-15"},"fiscalYearLabel":{"type":"string","description":"Label used in the source system for the fiscal year","example":"2025"},"language":{"$ref":"#/components/schemas/LanguageCode"},"externalCompanyId":{"type":"string","description":"External unique id of the company in the source system","example":"DE01"},"status":{"type":"string","description":"Current status of the project","example":"OPEN"},"startDate":{"type":"string","description":"Project start date","format":"date","example":"2025-01-01"},"endDate":{"type":"string","description":"Project end date","format":"date","example":"2025-01-01"},"type":{"type":"string","description":"Type of the project","example":"consulting"},"description":{"type":"string","description":"Detailed description of the project","example":"Reinforcement of Berlin transmission grid, including substation upgrades and cable replacements."},"shortDescription":{"type":"string","description":"Short description of the project","example":"Berlin Grid Upgrade"},"profitCenterCode":{"type":"string","description":"Code of the profit center associated with the project","example":"PC1001"},"responsibleCostCenterCode":{"type":"string","description":"Code of the responsible cost center","example":"CC2005"},"costCenterCodeForPosting":{"type":"string","description":"Code of the cost center for posting transactions","example":"CC3002"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"subProjectCode":{"type":"string","description":"Code of the sub-project if applicable","example":"BER-GRID-01"},"parentProjectCode":{"type":"string","description":"Code of the parent project if applicable","example":"PRJ-2025-INFRA"},"customFields":{"$ref":"#/components/schemas/customFields"},"customMetadata":{"$ref":"#/components/schemas/JsonObject"}}}},"schema_0":{"kind":"json-schema","data":{"type":"object","properties":{"x-ratelimit-limit":{"type":"string","description":"Indicates the request-quota associated to the client in the current time-window followed by the description of the quota policy.","example":"10, 10;w=1"},"x-ratelimit-remaining":{"type":"integer","description":"The number of remaining requests in the current time-window","example":94},"x-ratelimit-reset":{"type":"integer","description":"The number of seconds until quota reset of the current time-window","example":21}}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","maxLength":256},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"X-Hy-Filename":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a filename was provided during the file upload via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-Filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header, it will be returned in this header."},"children":[]}]}]}]}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Length":{"type":"integer","format":"int64","description":"Size of the file content in bytes."},"X-Hy-Filename":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a filename was provided during the file upload via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-Filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header, it will be returned in this header."},"children":[]}]}]}]}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"integer","minimum":0},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","default":20,"minimum":0,"maximum":50},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","enum":["createdAt","-createdAt","+createdAt","updatedAt","-updatedAt","+updatedAt"],"default":"-createdAt"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentState"}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CaseState"}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","pattern":"^[a-zA-Z]+$"}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A multipart response where each part corresponds to one file of the case."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each part contains the binary content of the file and the following headers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the media type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": contains the filename of the file"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-File-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the identifier of the file"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-File-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the type of the file as defined in the case"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Hy-File-Main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the main file of the case, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise"},"children":[]}]}]}]}]},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","format":"binary","description":"A ZIP archive containing all matching files of the case, each stored under its original filename."},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","example":"attachment; filename=\"case-6040dc9680b782b365ea77d5-files.zip\"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses, suggests a filename for the downloaded archive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case-{id}-files.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"3a429dc8-56d4-42ef-a4cf-2ebc9ad1ef38"}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CompaniesId"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","enum":["-createdAt","+createdAt"],"default":"-createdAt"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"title":"Search text used to find projects.","type":"string","description":"Search text is used against projects name and id"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ProjectId"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":0},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","nullable":true,"description":"Comma separated list of names and versions, eg agent1:v1,agent2:v2. At most 50 entries.","title":"Namesandversions"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"integer","description":"Maximum number of agents to return. Capped at 50; ignored when namesAndVersions is set.","default":20,"title":"Limit"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"integer","minimum":0,"description":"Number of agents to skip. Ignored when namesAndVersions is set.","default":0,"title":"Offset"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","minLength":1,"nullable":true,"description":"Return only agents whose editors contain this value. Cannot be combined with namesAndVersions.","title":"Editor"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"boolean","description":"Load the whole agent. In the paged list, prompt, configuration, systemPrompt, outputFormat and toolIds are null on every row by default, meaning 'not loaded' rather than empty. The namesAndVersions lookup always returns whole agents; there this flag only adds toolIds.","default":false,"title":"Full"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Id"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"boolean","description":"Whether to load versions","default":false,"title":"Withversions"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"boolean","description":"Whether to load lightweight version metadata (id, version, description, createdAt, createdBy)","default":false,"title":"Withversionsmetadata"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ExternalAgentPatch"},{"$ref":"#/components/schemas/ExternalOotbAgentPatch"}],"title":"AgentRootPatch"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","description":"The ID of the project","title":"Projectid"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"integer","description":"Maximum number of workflows to return. Capped at 50.","default":20,"title":"Limit"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"integer","minimum":0,"description":"Number of workflows to skip.","default":0,"title":"Offset"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","minLength":1,"nullable":true,"description":"Return only workflows whose editors contain this value.","title":"Editor"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ExternalWorkflowPatch"},{"$ref":"#/components/schemas/ExternalOotbWorkflowPatch"}],"title":"WorkflowRootPatch"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ScopeType"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"title":"Document identifier","type":"string"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"string","title":"Routing identifier","example":"6295dcd39db1ab740c3e296c"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"string","title":"Routing identifier"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","title":"Routing identifier 6295dcd39db1ab740c3e296c"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"integer","minimum":0,"title":"The limit used for this page of results.","default":20},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"integer","minimum":0,"title":"The offset used for this page of results.","default":0},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"title":"User identifier","type":"string"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","title":"Search text used to find users."},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"boolean","title":"Is active flag used to filter users."},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RoleName"},"type":"array","title":"User roles used to filter on."},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"integer","minimum":0,"exclusiveMinimum":true,"title":"The limit used for this page of results.","default":20},"id":"schema_51"}},"exampleStore":{"paths/~1auth~1token/post/responses/401/content/application~1json/example":{"value":{"detail":"The provided client credentials are not valid","status":401,"title":"Invalid client credentials"},"id":"paths/~1auth~1token/post/responses/401/content/application~1json/example"},"paths/~1files/post/responses/400/content/application~1json/example":{"value":{"detail":"The provided content type is not supported","status":400,"title":"Content type not supported"},"id":"paths/~1files/post/responses/400/content/application~1json/example"},"paths/~1files~1{id}/get/responses/404/content/application~1json/example":{"value":{"detail":"File with given identifier does not exist","status":404,"title":"File not found"},"id":"paths/~1files~1{id}/get/responses/404/content/application~1json/example"},"paths/~1documents/get/responses/400/content/application~1json/examples/InvalidProjectId":{"value":{"detail":"One of the given project identifier provided as projectId query parameter is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"InvalidProjectId","summary":"InvalidProjectId","id":"paths/~1documents/get/responses/400/content/application~1json/examples/InvalidProjectId"},"paths/~1documents/get/responses/400/content/application~1json/examples/OffsetOutOfRange":{"value":{"detail":"The provided offset is out of range","status":400,"title":"Offset out of range"},"key":"OffsetOutOfRange","summary":"OffsetOutOfRange","id":"paths/~1documents/get/responses/400/content/application~1json/examples/OffsetOutOfRange"},"paths/~1documents/get/responses/400/content/application~1json/examples/LimitOutOfRange":{"value":{"detail":"Limit is out of range","status":400,"title":"Limit out of range"},"key":"LimitOutOfRange","summary":"LimitOutOfRange","id":"paths/~1documents/get/responses/400/content/application~1json/examples/LimitOutOfRange"},"paths/~1documents/get/responses/400/content/application~1json/examples/InvalidSortDefinition":{"value":{"detail":"Limit is out of range","status":400,"title":"Limit out of range"},"key":"InvalidSortDefinition","summary":"InvalidSortDefinition","id":"paths/~1documents/get/responses/400/content/application~1json/examples/InvalidSortDefinition"},"paths/~1documents~1process-file/post/responses/400/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1process-file/post/responses/400/content/application~1json/example"},"paths/~1documents~1process-file/post/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1process-file/post/responses/404/content/application~1json/example"},"paths/~1documents~1{id}/get/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}/get/responses/404/content/application~1json/example"},"paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success":{"value":{"successful":true},"key":"success","summary":"Transferred  successfully","id":"paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/success"},"paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure":{"value":{"successful":false,"message":"Upload failed due to ERP being down"},"key":"failure","summary":"Transfer  failed","id":"paths/~1documents~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"},"paths/~1documents~1{id}~1transfer/post/responses/400/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1transfer/post/responses/400/content/application~1json/example"},"paths/~1documents~1{id}~1transfer/post/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1transfer/post/responses/404/content/application~1json/example"},"paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success":{"value":{"message":"Document was rejected!"},"key":"success","summary":"Rejected  successfully","id":"paths/~1documents~1{id}~1reject/post/requestBody/content/application~1json/examples/success"},"paths/~1documents~1{id}~1reject/post/responses/400/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1reject/post/responses/400/content/application~1json/example"},"paths/~1documents~1{id}~1reject/post/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1reject/post/responses/404/content/application~1json/example"},"paths/~1documents~1{id}~1external-data/post/responses/400/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1external-data/post/responses/400/content/application~1json/example"},"paths/~1documents~1{id}~1external-data/post/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1external-data/post/responses/404/content/application~1json/example"},"paths/~1documents~1{id}~1external-id/post/responses/400/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1external-id/post/responses/400/content/application~1json/example"},"paths/~1documents~1{id}~1external-id/post/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1external-id/post/responses/404/content/application~1json/example"},"paths/~1documents~1{id}~1title/post/responses/400/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1title/post/responses/400/content/application~1json/example"},"paths/~1documents~1{id}~1title/post/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1title/post/responses/404/content/application~1json/example"},"paths/~1documents~1{id}~1states/get/responses/404/content/application~1json/example":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"id":"paths/~1documents~1{id}~1states/get/responses/404/content/application~1json/example"},"paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic":{"value":{"fileIds":["bf105800-594d-48df-a5df-4d9d0554708d","3efd83f6-5009-4f9f-bc0c-4891c9a44e06"],"projectId":"69bbd0fbf8dbeab5f8db7675"},"key":"basic","summary":"Basic file batch processing request","id":"paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/basic"},"paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData":{"value":{"fileIds":["bf105800-594d-48df-a5df-4d9d0554708d","3efd83f6-5009-4f9f-bc0c-4891c9a44e06"],"projectId":"69bbd0fbf8dbeab5f8db7675","externalId":"batch-0001","externalData":{"internalSystemId":"sap-01"}},"key":"withExternalData","summary":"Request with external id and data","id":"paths/~1cases~1process-file-batch/post/requestBody/content/application~1json/examples/withExternalData"},"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notFound"},"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/badRequest"},"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1process-file-batch/post/responses/400/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notFound"},"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/badRequest"},"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1process-file-batch/post/responses/404/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notFound"},"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/badRequest"},"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1process-file-batch/post/responses/422/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact":{"value":{"files":[{"id":"92b5be52-ce1e-4c74-b1ba-b6897c5d447a","type":"invoice","mainFile":true,"passthroughArtifact":false},{"id":"76bf4146-3ab2-4a8b-8c93-081f1de780b7","type":"attachment","mainFile":false,"passthroughArtifact":true}],"projectId":"69bbd13093eba3eee76f3918"},"key":"withPassthroughArtifact","summary":"Process the signed invoice and retain the original email without processing or previewing it","id":"paths/~1cases~1create/post/requestBody/content/application~1json/examples/withPassthroughArtifact"},"paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic":{"value":{"files":[{"id":"92b5be52-ce1e-4c74-b1ba-b6897c5d447a","type":"salesOrder","mainFile":true},{"id":"76bf4146-3ab2-4a8b-8c93-081f1de780b7","type":"attachment","mainFile":false}],"projectId":"69bbd13093eba3eee76f3918"},"key":"basic","summary":"Basic case creation request","id":"paths/~1cases~1create/post/requestBody/content/application~1json/examples/basic"},"paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData":{"value":{"files":[{"id":"92b5be52-ce1e-4c74-b1ba-b6897c5d447a","type":"salesOrder","mainFile":true},{"id":"76bf4146-3ab2-4a8b-8c93-081f1de780b7","type":"attachment","mainFile":false}],"projectId":"69bbd13093eba3eee76f3918","externalId":"case-0001","externalData":{"internalSystemId":"sap-01"}},"key":"withExternalData","summary":"Request with external id and data","id":"paths/~1cases~1create/post/requestBody/content/application~1json/examples/withExternalData"},"paths/~1cases~1create/post/responses/400/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1create/post/responses/400/content/application~1json/examples/notFound"},"paths/~1cases~1create/post/responses/400/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1create/post/responses/400/content/application~1json/examples/badRequest"},"paths/~1cases~1create/post/responses/400/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1create/post/responses/400/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1create/post/responses/400/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1create/post/responses/400/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1create/post/responses/404/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1create/post/responses/404/content/application~1json/examples/notFound"},"paths/~1cases~1create/post/responses/404/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1create/post/responses/404/content/application~1json/examples/badRequest"},"paths/~1cases~1create/post/responses/404/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1create/post/responses/404/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1create/post/responses/404/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1create/post/responses/404/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1create/post/responses/422/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1create/post/responses/422/content/application~1json/examples/notFound"},"paths/~1cases~1create/post/responses/422/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1create/post/responses/422/content/application~1json/examples/badRequest"},"paths/~1cases~1create/post/responses/422/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1create/post/responses/422/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1create/post/responses/422/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1create/post/responses/422/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases/get/responses/400/content/application~1json/examples/InvalidProjectId":{"value":{"detail":"One of the given project identifiers provided as projectId query parameter is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"InvalidProjectId","summary":"InvalidProjectId","id":"paths/~1cases/get/responses/400/content/application~1json/examples/InvalidProjectId"},"paths/~1cases/get/responses/400/content/application~1json/examples/OffsetOutOfRange":{"value":{"detail":"The provided offset is out of range","status":400,"title":"Offset out of range"},"key":"OffsetOutOfRange","summary":"OffsetOutOfRange","id":"paths/~1cases/get/responses/400/content/application~1json/examples/OffsetOutOfRange"},"paths/~1cases/get/responses/400/content/application~1json/examples/LimitOutOfRange":{"value":{"detail":"Limit is out of range","status":400,"title":"Limit out of range"},"key":"LimitOutOfRange","summary":"LimitOutOfRange","id":"paths/~1cases/get/responses/400/content/application~1json/examples/LimitOutOfRange"},"paths/~1cases/get/responses/400/content/application~1json/examples/InvalidSortDefinition":{"value":{"detail":"The provided sort definition is invalid","status":400,"title":"Invalid sort definition"},"key":"InvalidSortDefinition","summary":"InvalidSortDefinition","id":"paths/~1cases/get/responses/400/content/application~1json/examples/InvalidSortDefinition"},"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/badRequest"},"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1{id}/get/responses/404/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success":{"value":{"successful":true},"key":"success","summary":"Transferred successfully","id":"paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/success"},"paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure":{"value":{"successful":false,"message":"Upload failed due to ERP being down"},"key":"failure","summary":"Transfer failed","id":"paths/~1cases~1{id}~1transfer/post/requestBody/content/application~1json/examples/failure"},"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notFound"},"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/badRequest"},"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1{id}~1transfer/post/responses/400/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notFound"},"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/badRequest"},"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1{id}~1transfer/post/responses/404/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notFound"},"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/badRequest"},"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1{id}~1files/get/responses/400/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notFound":{"value":{"detail":"One or more of the provided file identifiers do not exist","status":404,"title":"File not found"},"key":"notFound","summary":"notFound","id":"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notFound"},"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/badRequest":{"value":{"detail":"One of the given project identifiers provided as projectId is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"badRequest","summary":"badRequest","id":"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/badRequest"},"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notAPreProcessingProject":{"value":{"detail":"The project with the given identifier is not a pre-processing project and does not support file batch processing","status":422,"title":"Project does not support file batch processing"},"key":"notAPreProcessingProject","summary":"notAPreProcessingProject","id":"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/notAPreProcessingProject"},"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/isAPreProcessingProject":{"value":{"detail":"The project with the given identifier is a pre-processing project and does not support manual case creation","status":422,"title":"Project does not support manual case creation"},"key":"isAPreProcessingProject","summary":"isAPreProcessingProject","id":"paths/~1cases~1{id}~1files/get/responses/404/content/application~1json/examples/isAPreProcessingProject"},"paths/~1cases~1{id}~1files/get/responses/406/content/application~1json/example":{"value":{"detail":"The requested response format is not supported. Supported formats are multipart/mixed and application/zip.","status":406,"title":"Response format not supported"},"id":"paths/~1cases~1{id}~1files/get/responses/406/content/application~1json/example"},"paths/~1enrichment~1invoices~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1invoices~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1invoices~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1invoices~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1companies~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1companies~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1companies~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1companies~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1suppliers~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1suppliers~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1suppliers~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1suppliers~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1purchase-orders~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1purchase-orders~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1gl-accounts~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1gl-accounts~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1cost-centers~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1cost-centers~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1cost-centers~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1cost-centers~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1approvers~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1approvers~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1approvers~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1approvers~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1customers~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1customers~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1customers~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1customers~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1lookup-tables~1{type}~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1contracts~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1contracts~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1contracts~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1contracts~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1sales-orders~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1sales-orders~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1sales-orders~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1sales-orders~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1products~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1products~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1products~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1products~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1customer-products~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1customer-products~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1customer-products~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1customer-products~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1addresses~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1addresses~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1addresses~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1addresses~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1quotes~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1quotes~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1quotes~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1quotes~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1goods-receipts~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1goods-receipts~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1profit-centers~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1profit-centers~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1profit-centers~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1profit-centers~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1internal-orders~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1internal-orders~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1internal-orders~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1internal-orders~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1enrichment~1projects~1{externalId}/patch/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1projects~1{externalId}/patch/responses/404/content/application~1json/example"},"paths/~1enrichment~1projects~1{externalId}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Not found"},"id":"paths/~1enrichment~1projects~1{externalId}/delete/responses/404/content/application~1json/example"},"paths/~1companies~1{id}/get/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Invalid company ID","detail":"Error details"},"id":"paths/~1companies~1{id}/get/responses/400/content/application~1json/example"},"paths/~1companies~1{id}/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1companies~1{id}/get/responses/401/content/application~1json/example"},"paths/~1companies~1{id}/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1companies~1{id}/get/responses/403/content/application~1json/example"},"paths/~1companies~1{id}/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Company does not exists","detail":"Error details"},"id":"paths/~1companies~1{id}/get/responses/404/content/application~1json/example"},"paths/~1companies~1{id}/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1companies~1{id}/get/responses/500/content/application~1json/example"},"paths/~1projects/post/responses/400/content/application~1json/examples/Invalid request parameter":{"value":{"detail":"One of the given query parameters is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"Invalid request parameter","summary":"Invalid request parameter","id":"paths/~1projects/post/responses/400/content/application~1json/examples/Invalid request parameter"},"paths/~1projects/post/responses/400/content/application~1json/examples/Invalid payload data":{"value":{"detail":"Payload data couldn't be deserialised","status":400,"title":"Payload data is invalid"},"key":"Invalid payload data","summary":"Invalid payload data","id":"paths/~1projects/post/responses/400/content/application~1json/examples/Invalid payload data"},"paths/~1projects/post/responses/400/content/application~1json/examples/Extraction model not found":{"value":{"detail":"Extraction model 63e6663823b4c1f5287398bb not found for company 63fdf26693caabc81f83a674","status":400,"title":"Project extraction model does not exists"},"key":"Extraction model not found","summary":"Extraction model not found","id":"paths/~1projects/post/responses/400/content/application~1json/examples/Extraction model not found"},"paths/~1projects/post/responses/400/content/application~1json/examples/Default processing mode not found":{"value":{"detail":"Default processing mode for preProcessing not found for company 63fdf26693caabc81f83a674","status":400,"title":"Project extraction model does not exists"},"key":"Default processing mode not found","summary":"Default processing mode not found","id":"paths/~1projects/post/responses/400/content/application~1json/examples/Default processing mode not found"},"paths/~1projects/post/responses/401/content/application~1json/example":{"value":{"detail":"Provided no credentials or invalid credentials","status":401,"title":"Unauthorized"},"id":"paths/~1projects/post/responses/401/content/application~1json/example"},"paths/~1projects/post/responses/403/content/application~1json/example":{"value":{"detail":"Not enough privileges to perform an action on a resource","status":403,"title":"Forbidden"},"id":"paths/~1projects/post/responses/403/content/application~1json/example"},"paths/~1projects/post/responses/404/content/application~1json/examples/Project not found":{"value":{"detail":"The project with given identifier does not exist","status":404,"title":"Project does not exist"},"key":"Project not found","summary":"Project not found","id":"paths/~1projects/post/responses/404/content/application~1json/examples/Project not found"},"paths/~1projects/post/responses/422/content/application~1json/examples/Request validation error":{"value":{"detail":"Error details","status":422,"title":"Request validation error"},"key":"Request validation error","summary":"Request validation error","id":"paths/~1projects/post/responses/422/content/application~1json/examples/Request validation error"},"paths/~1projects/post/responses/422/content/application~1json/examples/Unsupported OCR engine":{"value":{"detail":"Only Google and Internal OCR engines are currently supported. Received: abbyy.","status":422,"title":"Request validation error"},"key":"Unsupported OCR engine","summary":"Unsupported OCR engine","id":"paths/~1projects/post/responses/422/content/application~1json/examples/Unsupported OCR engine"},"paths/~1projects/post/responses/422/content/application~1json/examples/Processing mode mismatch":{"value":{"detail":"extractionModelId must match the automatically selected Cases processing mode for preProcessing and execution projects","status":422,"title":"Project validation failed"},"key":"Processing mode mismatch","summary":"Processing mode mismatch","id":"paths/~1projects/post/responses/422/content/application~1json/examples/Processing mode mismatch"},"paths/~1projects/post/responses/422/content/application~1json/examples/Malformed processing mode id":{"value":{"detail":"Invalid extractionModelId: expected a MongoDB ObjectId","status":422,"title":"Project validation failed"},"key":"Malformed processing mode id","summary":"Malformed processing mode id","id":"paths/~1projects/post/responses/422/content/application~1json/examples/Malformed processing mode id"},"paths/~1projects/post/responses/422/content/application~1json/examples/Null word regions setting":{"value":{"detail":"Project word region generation setting cannot be null","status":422,"title":"Project validation failed"},"key":"Null word regions setting","summary":"Null word regions setting","id":"paths/~1projects/post/responses/422/content/application~1json/examples/Null word regions setting"},"paths/~1projects/get/responses/401/content/application~1json/example":{"value":{"detail":"Provided no credentials or invalid credentials","status":401,"title":"Unauthorized"},"id":"paths/~1projects/get/responses/401/content/application~1json/example"},"paths/~1projects/get/responses/403/content/application~1json/example":{"value":{"detail":"Not enough privileges to perform an action on a resource","status":403,"title":"Forbidden"},"id":"paths/~1projects/get/responses/403/content/application~1json/example"},"paths/~1projects/get/responses/422/content/application~1json/examples/Request validation error":{"value":{"detail":"Error details","status":422,"title":"Request validation error"},"key":"Request validation error","summary":"Request validation error","id":"paths/~1projects/get/responses/422/content/application~1json/examples/Request validation error"},"paths/~1projects/get/responses/422/content/application~1json/examples/Unsupported OCR engine":{"value":{"detail":"Only Google and Internal OCR engines are currently supported. Received: abbyy.","status":422,"title":"Request validation error"},"key":"Unsupported OCR engine","summary":"Unsupported OCR engine","id":"paths/~1projects/get/responses/422/content/application~1json/examples/Unsupported OCR engine"},"paths/~1projects/get/responses/422/content/application~1json/examples/Processing mode mismatch":{"value":{"detail":"extractionModelId must match the automatically selected Cases processing mode for preProcessing and execution projects","status":422,"title":"Project validation failed"},"key":"Processing mode mismatch","summary":"Processing mode mismatch","id":"paths/~1projects/get/responses/422/content/application~1json/examples/Processing mode mismatch"},"paths/~1projects/get/responses/422/content/application~1json/examples/Malformed processing mode id":{"value":{"detail":"Invalid extractionModelId: expected a MongoDB ObjectId","status":422,"title":"Project validation failed"},"key":"Malformed processing mode id","summary":"Malformed processing mode id","id":"paths/~1projects/get/responses/422/content/application~1json/examples/Malformed processing mode id"},"paths/~1projects/get/responses/422/content/application~1json/examples/Null word regions setting":{"value":{"detail":"Project word region generation setting cannot be null","status":422,"title":"Project validation failed"},"key":"Null word regions setting","summary":"Null word regions setting","id":"paths/~1projects/get/responses/422/content/application~1json/examples/Null word regions setting"},"paths/~1projects/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1projects/get/responses/500/content/application~1json/example"},"paths/~1projects~1{id}/get/responses/401/content/application~1json/example":{"value":{"detail":"Provided no credentials or invalid credentials","status":401,"title":"Unauthorized"},"id":"paths/~1projects~1{id}/get/responses/401/content/application~1json/example"},"paths/~1projects~1{id}/get/responses/403/content/application~1json/example":{"value":{"detail":"Not enough privileges to perform an action on a resource","status":403,"title":"Forbidden"},"id":"paths/~1projects~1{id}/get/responses/403/content/application~1json/example"},"paths/~1projects~1{id}/get/responses/404/content/application~1json/examples/Project not found":{"value":{"detail":"The project with given identifier does not exist","status":404,"title":"Project does not exist"},"key":"Project not found","summary":"Project not found","id":"paths/~1projects~1{id}/get/responses/404/content/application~1json/examples/Project not found"},"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid request parameter":{"value":{"detail":"One of the given query parameters is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"Invalid request parameter","summary":"Invalid request parameter","id":"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid request parameter"},"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid payload data":{"value":{"detail":"Payload data couldn't be deserialised","status":400,"title":"Payload data is invalid"},"key":"Invalid payload data","summary":"Invalid payload data","id":"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Invalid payload data"},"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Extraction model not found":{"value":{"detail":"Extraction model 63e6663823b4c1f5287398bb not found for company 63fdf26693caabc81f83a674","status":400,"title":"Project extraction model does not exists"},"key":"Extraction model not found","summary":"Extraction model not found","id":"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Extraction model not found"},"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Default processing mode not found":{"value":{"detail":"Default processing mode for preProcessing not found for company 63fdf26693caabc81f83a674","status":400,"title":"Project extraction model does not exists"},"key":"Default processing mode not found","summary":"Default processing mode not found","id":"paths/~1projects~1{id}/patch/responses/400/content/application~1json/examples/Default processing mode not found"},"paths/~1projects~1{id}/patch/responses/401/content/application~1json/example":{"value":{"detail":"Provided no credentials or invalid credentials","status":401,"title":"Unauthorized"},"id":"paths/~1projects~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1projects~1{id}/patch/responses/403/content/application~1json/example":{"value":{"detail":"Not enough privileges to perform an action on a resource","status":403,"title":"Forbidden"},"id":"paths/~1projects~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1projects~1{id}/patch/responses/404/content/application~1json/examples/Project not found":{"value":{"detail":"The project with given identifier does not exist","status":404,"title":"Project does not exist"},"key":"Project not found","summary":"Project not found","id":"paths/~1projects~1{id}/patch/responses/404/content/application~1json/examples/Project not found"},"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Request validation error":{"value":{"detail":"Error details","status":422,"title":"Request validation error"},"key":"Request validation error","summary":"Request validation error","id":"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Request validation error"},"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Unsupported OCR engine":{"value":{"detail":"Only Google and Internal OCR engines are currently supported. Received: abbyy.","status":422,"title":"Request validation error"},"key":"Unsupported OCR engine","summary":"Unsupported OCR engine","id":"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Unsupported OCR engine"},"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Processing mode mismatch":{"value":{"detail":"extractionModelId must match the automatically selected Cases processing mode for preProcessing and execution projects","status":422,"title":"Project validation failed"},"key":"Processing mode mismatch","summary":"Processing mode mismatch","id":"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Processing mode mismatch"},"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Malformed processing mode id":{"value":{"detail":"Invalid extractionModelId: expected a MongoDB ObjectId","status":422,"title":"Project validation failed"},"key":"Malformed processing mode id","summary":"Malformed processing mode id","id":"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Malformed processing mode id"},"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Null word regions setting":{"value":{"detail":"Project word region generation setting cannot be null","status":422,"title":"Project validation failed"},"key":"Null word regions setting","summary":"Null word regions setting","id":"paths/~1projects~1{id}/patch/responses/422/content/application~1json/examples/Null word regions setting"},"paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid request parameter":{"value":{"detail":"One of the given query parameters is invalid","status":400,"title":"Provided project identifier is invalid"},"key":"Invalid request parameter","summary":"Invalid request parameter","id":"paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid request parameter"},"paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid payload data":{"value":{"detail":"One or more of the payload parameters are invalid","status":400,"title":"Provided payload is invalid"},"key":"Invalid payload data","summary":"Invalid payload data","id":"paths/~1projects~1{id}~1schema/get/responses/400/content/application~1json/examples/Invalid payload data"},"paths/~1projects~1{id}~1schema/get/responses/401/content/application~1json/example":{"value":{"detail":"Provided no credentials or invalid credentials","status":401,"title":"Unauthorized"},"id":"paths/~1projects~1{id}~1schema/get/responses/401/content/application~1json/example"},"paths/~1projects~1{id}~1schema/get/responses/403/content/application~1json/example":{"value":{"detail":"Not enough privileges to perform an action on a resource","status":403,"title":"Forbidden"},"id":"paths/~1projects~1{id}~1schema/get/responses/403/content/application~1json/example"},"paths/~1projects~1{id}~1schema/get/responses/404/content/application~1json/examples/Project not found":{"value":{"detail":"The project with given identifier does not exist","status":404,"title":"Project does not exist"},"key":"Project not found","summary":"Project not found","id":"paths/~1projects~1{id}~1schema/get/responses/404/content/application~1json/examples/Project not found"},"paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/documentNotFound":{"value":{"detail":"The document with given identifier does not exist","status":404,"title":"Document does not exist"},"key":"documentNotFound","summary":"Document does not exist","id":"paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/documentNotFound"},"paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/previewNotFound":{"value":{"detail":"The document preview with given identifier does not exist","status":404,"title":"Document preview does not exist"},"key":"previewNotFound","summary":"Document preview does not exist","id":"paths/~1e-invoices~1{id}~1preview/get/responses/404/content/application~1json/examples/previewNotFound"},"paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel":{"value":{"variables":[{"name":"emailSender","value":"noreply","description":"Default email sender address"},{"name":"notifyEnabled","value":"true","description":"Toggle system notifications"}]},"key":"companyLevel","summary":"Company-level variables","id":"paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/companyLevel"},"paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel":{"value":{"scopeType":"PROJECT","scopeId":"66e80e8f4e8215461076e24b","variables":[{"name":"emailReplyTo","value":"project_support","description":"Project-specific reply-to address"}]},"key":"projectLevel","summary":"Project-scoped variables","id":"paths/~1context-vars~1configurations/put/requestBody/content/application~1json/examples/projectLevel"},"paths/~1context-vars~1resolve/get/responses/200/content/application~1json/examples/example1":{"value":{"emailSender":"noreply","emailReplyTo":"support","notifyEnabled":"true"},"key":"example1","summary":"example1","id":"paths/~1context-vars~1resolve/get/responses/200/content/application~1json/examples/example1"},"paths/~1emails~1{id}~1content/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1emails~1{id}~1content/get/responses/401/content/application~1json/example"},"paths/~1emails~1{id}~1content/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1emails~1{id}~1content/get/responses/403/content/application~1json/example"},"paths/~1emails~1{id}~1content/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Emails information does not exists","detail":"Error details"},"id":"paths/~1emails~1{id}~1content/get/responses/404/content/application~1json/example"},"paths/~1emails~1{id}~1content/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1emails~1{id}~1content/get/responses/500/content/application~1json/example"},"paths/~1emails~1{id}/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1emails~1{id}/get/responses/401/content/application~1json/example"},"paths/~1emails~1{id}/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1emails~1{id}/get/responses/403/content/application~1json/example"},"paths/~1emails~1{id}/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Emails information does not exists","detail":"Error details"},"id":"paths/~1emails~1{id}/get/responses/404/content/application~1json/example"},"paths/~1emails~1{id}/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1emails~1{id}/get/responses/500/content/application~1json/example"},"paths/~1emails~1{id}~1eml/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1emails~1{id}~1eml/get/responses/401/content/application~1json/example"},"paths/~1emails~1{id}~1eml/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1emails~1{id}~1eml/get/responses/403/content/application~1json/example"},"paths/~1emails~1{id}~1eml/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Emails information does not exists","detail":"Error details"},"id":"paths/~1emails~1{id}~1eml/get/responses/404/content/application~1json/example"},"paths/~1emails~1{id}~1eml/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1emails~1{id}~1eml/get/responses/500/content/application~1json/example"},"paths/~1routings~1{id}/get/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Routing project does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}/get/responses/400/content/application~1json/example"},"paths/~1routings~1{id}/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1routings~1{id}/get/responses/401/content/application~1json/example"},"paths/~1routings~1{id}/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1routings~1{id}/get/responses/403/content/application~1json/example"},"paths/~1routings~1{id}/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Document routing does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}/get/responses/404/content/application~1json/example"},"paths/~1routings~1{id}/get/responses/422/content/application~1json/example":{"value":{"status":422,"title":"Request validation error","detail":"Error details"},"id":"paths/~1routings~1{id}/get/responses/422/content/application~1json/example"},"paths/~1routings~1{id}/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1routings~1{id}/get/responses/500/content/application~1json/example"},"paths/~1routings~1{id}/put/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Routing project does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}/put/responses/400/content/application~1json/example"},"paths/~1routings~1{id}/put/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1routings~1{id}/put/responses/401/content/application~1json/example"},"paths/~1routings~1{id}/put/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1routings~1{id}/put/responses/403/content/application~1json/example"},"paths/~1routings~1{id}/put/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Document routing does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}/put/responses/404/content/application~1json/example"},"paths/~1routings~1{id}/put/responses/422/content/application~1json/example":{"value":{"status":422,"title":"Request validation error","detail":"Error details"},"id":"paths/~1routings~1{id}/put/responses/422/content/application~1json/example"},"paths/~1routings~1{id}/put/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1routings~1{id}/put/responses/500/content/application~1json/example"},"paths/~1routings~1{id}/delete/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Routing project does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}/delete/responses/400/content/application~1json/example"},"paths/~1routings~1{id}/delete/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1routings~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1routings~1{id}/delete/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1routings~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1routings~1{id}/delete/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Document routing does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1routings~1{id}/delete/responses/422/content/application~1json/example":{"value":{"status":422,"title":"Request validation error","detail":"Error details"},"id":"paths/~1routings~1{id}/delete/responses/422/content/application~1json/example"},"paths/~1routings~1{id}/delete/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1routings~1{id}/delete/responses/500/content/application~1json/example"},"paths/~1routings/get/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Routing project does not exists","detail":"Error details"},"id":"paths/~1routings/get/responses/400/content/application~1json/example"},"paths/~1routings/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1routings/get/responses/401/content/application~1json/example"},"paths/~1routings/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1routings/get/responses/403/content/application~1json/example"},"paths/~1routings/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Document routing does not exists","detail":"Error details"},"id":"paths/~1routings/get/responses/404/content/application~1json/example"},"paths/~1routings/get/responses/422/content/application~1json/example":{"value":{"status":422,"title":"Request validation error","detail":"Error details"},"id":"paths/~1routings/get/responses/422/content/application~1json/example"},"paths/~1routings/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1routings/get/responses/500/content/application~1json/example"},"paths/~1routings/post/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Routing project does not exists","detail":"Error details"},"id":"paths/~1routings/post/responses/400/content/application~1json/example"},"paths/~1routings/post/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1routings/post/responses/401/content/application~1json/example"},"paths/~1routings/post/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1routings/post/responses/403/content/application~1json/example"},"paths/~1routings/post/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Document routing does not exists","detail":"Error details"},"id":"paths/~1routings/post/responses/404/content/application~1json/example"},"paths/~1routings/post/responses/422/content/application~1json/example":{"value":{"status":422,"title":"Request validation error","detail":"Error details"},"id":"paths/~1routings/post/responses/422/content/application~1json/example"},"paths/~1routings/post/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1routings/post/responses/500/content/application~1json/example"},"paths/~1routings~1{id}~1order/post/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Routing project does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}~1order/post/responses/400/content/application~1json/example"},"paths/~1routings~1{id}~1order/post/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1routings~1{id}~1order/post/responses/401/content/application~1json/example"},"paths/~1routings~1{id}~1order/post/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1routings~1{id}~1order/post/responses/403/content/application~1json/example"},"paths/~1routings~1{id}~1order/post/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Document routing does not exists","detail":"Error details"},"id":"paths/~1routings~1{id}~1order/post/responses/404/content/application~1json/example"},"paths/~1routings~1{id}~1order/post/responses/422/content/application~1json/example":{"value":{"status":422,"title":"Request validation error","detail":"Error details"},"id":"paths/~1routings~1{id}~1order/post/responses/422/content/application~1json/example"},"paths/~1routings~1{id}~1order/post/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1routings~1{id}~1order/post/responses/500/content/application~1json/example"},"paths/~1users~1{id}/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1users~1{id}/get/responses/401/content/application~1json/example"},"paths/~1users~1{id}/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1users~1{id}/get/responses/403/content/application~1json/example"},"paths/~1users~1{id}/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"User does not exists","detail":"Error details"},"id":"paths/~1users~1{id}/get/responses/404/content/application~1json/example"},"paths/~1users~1{id}/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1users~1{id}/get/responses/500/content/application~1json/example"},"paths/~1users/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1users/get/responses/401/content/application~1json/example"},"paths/~1users/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1users/get/responses/403/content/application~1json/example"},"paths/~1users/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"User does not exists","detail":"Error details"},"id":"paths/~1users/get/responses/404/content/application~1json/example"},"paths/~1users/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1users/get/responses/500/content/application~1json/example"},"paths/~1processing-modes/get/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Invalid company ID","detail":"Error details"},"id":"paths/~1processing-modes/get/responses/400/content/application~1json/example"},"paths/~1processing-modes/get/responses/401/content/application~1json/example":{"value":{"status":401,"title":"Invalid token","detail":"Error details"},"id":"paths/~1processing-modes/get/responses/401/content/application~1json/example"},"paths/~1processing-modes/get/responses/403/content/application~1json/example":{"value":{"status":403,"title":"Forbidden","detail":"Error details"},"id":"paths/~1processing-modes/get/responses/403/content/application~1json/example"},"paths/~1processing-modes/get/responses/404/content/application~1json/example":{"value":{"status":404,"title":"Company does not exists","detail":"Error details"},"id":"paths/~1processing-modes/get/responses/404/content/application~1json/example"},"paths/~1processing-modes/get/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal Server Error","detail":"Error details"},"id":"paths/~1processing-modes/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/auth/token","scopes":{"companies.read":"Read companies","documents.read":"Read documents","documents.write":"Edit your documents","enrichment.read":"Read enrichment training data","enrichment.write":"Create/edit enrichment training data","enrichment.delete":"Delete enrichment training data","files.read":"Uploading files for processing","files.write":"Downloading uploaded files","projects.write":"Create/edit projects data","projects.read":"Read projects data","emails.read":"Read emails data","agents.read":"Read agents","agents.write":"Create, update and delete agents","agent-workflows.read":"Read agent workflows","agent-workflows.write":"Create, update and delete agent workflows"}}}},"Basic":{"id":"Basic","type":"http","scheme":"basic"}},"servers":[{"url":"https://api.cloud.hypatos.ai/v2","description":"API EU"},{"url":"https://api.cloud.hypatos.com/v2","description":"API US"},{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"JavaScript"}]},"mockServer":{"url":"/_mock/openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Hypatos REST API","description":"# Introduction\n\nThe Hypatos API is organized around REST. The majority of the endpoints provide CRUD \nfunctionality for resources. The API is also exposing Intent Resources which mimic user intents \nor actions.\n\nThe Hypatos API uses [OAuth 2.0 Client Credential Grant](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) \nto authenticate requests. Before making any requests to any endpoint a client must authenticate \nwith the authorization server and requests an access token from the [token endpoint](#operation/requestAccessToken). \n\n````sh\n  POST /auth/token HTTP/1.1\n  Host: api.cloud.hypatos.ai\n  Content-Type: application/x-www-form-urlencoded\n  Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=\n\n  grant_type=client_credentials\n````\n\n`Authorization` header contains `client_id:client_secret` encoded as explained in [RFC Client Password section](https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1).\n     \nIf the authorization server authenticated the client successfully, an access token is issued. \nHere is an example successful response:\n\n````sh\n  HTTP/1.1 200 OK\n  Content-Type: application/json;charset=UTF-8\n  Cache-Control: no-store\n  Pragma: no-cache\n\n  {\n    \"access_token\": \"mF_9.B5f-4.1JqM\",\n    \"expires_in\": 86400,\n    \"scope\": \"enrichment.write files.read\",\n    \"token_type\": \"Bearer\",\n  }\n````\nThis token can be used to authenticate the requests to API endpoints by sending a Bearer token \nin the `Authorization` HTTP header. The following example demonstrates how to use the access token \nto retrieve a list of documents.\n\n````sh\n  GET /v2/documents HTTP/1.1\n  Host: api.cloud.hypatos.ai\n  Authorization: Bearer mF_9.B5f-4.1JqM\n````\n\n# Versioning\n\nChanges to this API are released regularly. We use [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) \nscheme for versioning so that the clients can identify any backward-incompatible changes \neasily. Briefly summarized one can say, if the MAJOR version of the new API version didn't \nchange you can expect the new version to be backward-compatible.\n\n# Rate limits\n\nIn order to maximise the stability of our API, we institue rate limits for all of API \nendpoints. Clients who send too many requests over a given period of time will see error \nresponses that show up as status code [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429). \n\nWhen you see error responses with status code 429, it means you exhausted your current \nquota and need to withhold from sending further requests until the quota is reset. We \nencourage you not to wait until you get a 429 error but to monitor your quota in each \nrequest. In each response you receive from the API, you will find HTTP headers providing \nthe details about your current quota. Here is the list of the HTTP headers:\n\n* `x-ratelimit-limit`: Indicates the quota associated to the client in the \ncurrent time-window followed by the description of the quota policy.\n* `x-ratelimit-remaining`: Indicates the number of remaining requests in the current \ntime-window\n* `x-ratelimit-reset`: Indicates the number of seconds until quota reset of the current \ntime-window\n\nPlease note that IETF is currently in the process of publishing a standard for these \nheaders. Please explore the [draft](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/) \nfor more details.\n\nA basic technique to gracefully handle rate limits is watch for your quota permanently \nand increase the time between your request as the quota is decreasing. To recover from a \n429 error you need a retry mechanism following an exponential backoff schedule.\n"}},"baseSlug":"/openapi","routesMapping":{}}