{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:hypatos/authorization-request-access-token":{"post":{"operationId":"security_hypatos_authorization_request_access_token","summary":"Request an access token","description":"POST /auth/token","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/files-upload-file":{"post":{"operationId":"security_hypatos_files_upload_file","summary":"Upload a file","description":"POST /files","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Hy-Filename":{"type":"string","description":"Optional name of the file to be stored along with the content. If not provided, a filename will be generated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/files-download-by-id":{"get":{"operationId":"security_hypatos_files_download_by_id","summary":"Download a file by id","description":"GET /files/{id}","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"File id to download","schema":{"type":"string","description":"File id to download"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-get-list":{"get":{"operationId":"security_hypatos_documents_get_list","summary":"Retrieve a list of documents","description":"GET /documents","tags":["security"],"parameters":[{"name":"projectId","in":"query","required":false,"description":"Project ids to to find items by. If ommitted, items from all existing projects are returned.","schema":{"type":"array","description":"Project ids to to find items by. If ommitted, items from all existing projects are returned."}},{"name":"offset","in":"query","required":false,"description":"A zero-based offset of the first item in the data collection to return.","schema":{"type":"integer","description":"A zero-based offset of the first item in the data collection to return."}},{"name":"limit","in":"query","required":false,"description":"Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used.","schema":{"type":"integer","default":20,"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","required":false,"description":"The field to sort reponse items by.","schema":{"type":"string","enum":["createdAt","-createdAt","+createdAt","updatedAt","-updatedAt","+updatedAt"],"default":"-createdAt","description":"The field to sort reponse items by."}},{"name":"state","in":"query","required":false,"description":"Used to retrieve documents that are in specific states only. Multiple states can be used for this filtering. By default, documents in all…","schema":{"type":"array","description":"Used to retrieve documents that are in specific states only. Multiple states can be used for this filtering. By default, documents in all…"}},{"name":"fileId","in":"query","required":false,"description":"File identifier to retrieve documents that were created from that file","schema":{"type":"string","description":"File identifier to retrieve documents that were created from that file"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-process-file-into-document":{"post":{"operationId":"security_hypatos_documents_process_file_into_document","summary":"Request processing of a file","description":"POST /documents/process-file","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-get-by-id":{"get":{"operationId":"security_hypatos_documents_get_by_id","summary":"Retrieve a document by id","description":"GET /documents/{id}","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the document to get.","schema":{"type":"string","description":"Id of the document to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-update-transfer-information":{"post":{"operationId":"security_hypatos_documents_update_transfer_information","summary":"Provide information about a transfer of a document to the target system","description":"POST /documents/{id}/transfer","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Id of of the document to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-update-external-data":{"post":{"operationId":"security_hypatos_documents_update_external_data","summary":"Provide external data for a document with given id","description":"POST /documents/{id}/external-data","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Id of the document to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-provide-external-id":{"post":{"operationId":"security_hypatos_documents_provide_external_id","summary":"Provide an external identifier for a document with given id","description":"POST /documents/{id}/external-id","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the document to update."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-provide-title":{"post":{"operationId":"security_hypatos_documents_provide_title","summary":"Provide a title for a document with given id","description":"POST /documents/{id}/title","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the document to update."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/documents-get-document-states":{"get":{"operationId":"security_hypatos_documents_get_document_states","summary":"Retrieve a document states","description":"GET /documents/{id}/states","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the document to get states of.","schema":{"type":"string","description":"Id of the document to get states of."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-invoice-including-invoice-lines":{"post":{"operationId":"security_hypatos_enrichment_insert_invoice_including_invoice_lines","summary":"Insert invoice including invoice lines","description":"POST /enrichment/invoices","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-invoice-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_invoice_deleted","summary":"Mark invoice as deleted","description":"DELETE /enrichment/invoices/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"},"lineNumber":{"type":"string","description":"Line number of one of the line numbers inside the Invoice. Optional, omitting means the whole Invoice is deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-add-company-data":{"post":{"operationId":"security_hypatos_enrichment_add_company_data","summary":"Insert company","description":"POST /enrichment/companies","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-company-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_company_deleted","summary":"Mark company as deleted","description":"DELETE /enrichment/companies/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-supplier-including-subsidiaries":{"post":{"operationId":"security_hypatos_enrichment_insert_supplier_including_subsidiaries","summary":"Insert supplier including related subsidiaries","description":"POST /enrichment/suppliers","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-supplier-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_supplier_deleted","summary":"Mark supplier as deleted","description":"DELETE /enrichment/suppliers/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-purchase-order":{"post":{"operationId":"security_hypatos_enrichment_insert_purchase_order","summary":"Insert purchase order including purchase order lines","description":"POST /enrichment/purchase-orders","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-purchase-order-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_purchase_order_deleted","summary":"Mark purchase Order as deleted","description":"DELETE /enrichment/purchase-orders/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"},"lineNumber":{"type":"string","description":"Line number of one of the line numbers inside the PO. Optional, omitting means the whole PO is deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-gl-account":{"post":{"operationId":"security_hypatos_enrichment_insert_gl_account","summary":"Insert general ledger account","description":"POST /enrichment/gl-accounts","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-gl-account-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_gl_account_deleted","summary":"Mark general ledger account as deleted","description":"DELETE /enrichment/gl-accounts/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-cost-center":{"post":{"operationId":"security_hypatos_enrichment_insert_cost_center","summary":"Insert cost center","description":"POST /enrichment/cost-centers","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-cost-center-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_cost_center_deleted","summary":"Mark cost Center as deleted","description":"DELETE /enrichment/cost-centers/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-approver-record":{"post":{"operationId":"security_hypatos_enrichment_insert_approver_record","summary":"Insert approver","description":"POST /enrichment/approvers","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-approver-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_approver_deleted","summary":"Mark approver as deleted","description":"DELETE /enrichment/approvers/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-insert-customer":{"post":{"operationId":"security_hypatos_enrichment_insert_customer","summary":"Insert customer","description":"POST /enrichment/customers","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/enrichment-mark-customer-as-deleted":{"post":{"operationId":"security_hypatos_enrichment_mark_customer_as_deleted","summary":"Mark customer as deleted","description":"DELETE /enrichment/customers/{externalId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"Previously sent `externalId`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/companies-get-by-id":{"get":{"operationId":"security_hypatos_companies_get_by_id","summary":"Retrieve a company by id","description":"GET /companies/{id}","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the company to retrieve","schema":{"type":"string","description":"Id of the company to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/companies-list":{"get":{"operationId":"security_hypatos_companies_list","summary":"Retrieve a list of companies","description":"GET /companies","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/projects-list-for-given-search-criteria":{"get":{"operationId":"security_hypatos_projects_list_for_given_search_criteria","summary":"Retrieve a projects list for given search criteria","description":"GET /projects","tags":["security"],"parameters":[{"name":"offset","in":"query","required":false,"description":"A zero-based offset of the first item in the data collection to return.","schema":{"type":"integer","description":"A zero-based offset of the first item in the data collection to return."}},{"name":"limit","in":"query","required":false,"description":"Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used.","schema":{"type":"integer","default":20,"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","required":false,"description":"The field to sort reponse items by.","schema":{"type":"string","enum":["-createdAt","+createdAt"],"default":"-createdAt","description":"The field to sort reponse items by."}},{"name":"search","in":"query","required":false,"description":"Search text is used against projects name and id","schema":{"type":"string","description":"Search text is used against projects name and id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/projects-create-project":{"post":{"operationId":"security_hypatos_projects_create_project","summary":"Create a project","description":"POST /projects","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:hypatos/projects-get-by-id":{"get":{"operationId":"security_hypatos_projects_get_by_id","summary":"Retrieve a project by id","description":"GET /projects/{id}","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"Project id","schema":{"type":"string","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/projects-get-schema-by-project-id":{"get":{"operationId":"security_hypatos_projects_get_schema_by_project_id","summary":"Retrieve a schema by project id","description":"GET /projects/{id}/schema","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"Project id","schema":{"type":"string","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:hypatos/emails-get-merged-content-by-id":{"get":{"operationId":"security_hypatos_emails_get_merged_content_by_id","summary":"Retrieve an email merged content for given document ID","description":"GET /emails/{id}/content","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"6295dcd39db1ab740c3e296c"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}