{"openapi":"3.1.0","info":{"title":"InMyWords integrations API","version":"1.0.0","description":"REST at /v1/ and SCIM 2.0 at /scim/v2/ for one organisation's connection. Every call carries the connection's key as a bearer token. Guides: https://inmywords.chat/support/integrations/","contact":{"name":"INT6 Ltd","url":"https://inmywords.chat/contact/"},"x-build":"47"},"servers":[{"url":"https://app.inmywords.chat/api/integrations"}],"security":[{"bearer":[]}],"tags":[{"name":"Description"},{"name":"Connection"},{"name":"Conversations"},{"name":"Cases"},{"name":"Documents"},{"name":"People"},{"name":"Groups"},{"name":"Webhooks"},{"name":"SCIM"}],"paths":{"/scim/v2/Groups":{"get":{"operationId":"IntScim_GroupList","summary":"Groups; filter displayName eq; excludedAttributes=members.","tags":["SCIM"],"x-scope":"groups:read","security":[{"bearer":["groups:read"]}],"parameters":[{"$ref":"#/components/parameters/ScimFilter"},{"$ref":"#/components/parameters/ScimStartIndex"},{"$ref":"#/components/parameters/ScimCount"},{"$ref":"#/components/parameters/ScimExcluded"}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimList"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"post":{"operationId":"IntScim_GroupCreate","summary":"Make a group, starting with no permissions; members need users:write too.","tags":["SCIM"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"responses":{"201":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"422":{"$ref":"#/components/responses/ScimE422"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"422":["validation_failed"]}}},"/scim/v2/Groups/{id}":{"get":{"operationId":"IntScim_GroupGet","summary":"One group.","tags":["SCIM"],"x-scope":"groups:read","security":[{"bearer":["groups:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."},{"$ref":"#/components/parameters/ScimExcluded"}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"put":{"operationId":"IntScim_GroupPut","summary":"Replace a group's name and members.","tags":["SCIM"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"422":{"$ref":"#/components/responses/ScimE422"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"422":["validation_failed"]}},"patch":{"operationId":"IntScim_GroupPatch","summary":"Change a group's name or members; all or nothing.","tags":["SCIM"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimPatch"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScimPatch"}}}},"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"422":{"$ref":"#/components/responses/ScimE422"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"422":["validation_failed"]}},"delete":{"operationId":"IntScim_GroupDelete","summary":"Delete a group.","tags":["SCIM"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"204":{"description":"Done. No body."},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/scim/v2/ResourceTypes":{"get":{"operationId":"IntScim_ResourceTypes","summary":"User and Group.","tags":["SCIM"],"x-scope":null,"security":[{"bearer":[]}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimAny"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/scim/v2/Schemas":{"get":{"operationId":"IntScim_Schemas","summary":"The User and Group schemas as supported.","tags":["SCIM"],"x-scope":null,"security":[{"bearer":[]}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimAny"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/scim/v2/ServiceProviderConfig":{"get":{"operationId":"IntScim_ServiceProviderConfig","summary":"What this SCIM service supports.","tags":["SCIM"],"x-scope":null,"security":[{"bearer":[]}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimAny"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/scim/v2/Users":{"get":{"operationId":"IntScim_UserList","summary":"Users; filter userName eq, externalId eq or displayName eq.","tags":["SCIM"],"x-scope":"users:read","security":[{"bearer":["users:read"]}],"parameters":[{"$ref":"#/components/parameters/ScimFilter"},{"$ref":"#/components/parameters/ScimStartIndex"},{"$ref":"#/components/parameters/ScimCount"}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimList"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"post":{"operationId":"IntScim_UserCreate","summary":"Create or invite a user.","tags":["SCIM"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"responses":{"201":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"422":{"$ref":"#/components/responses/ScimE422"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"422":["validation_failed"]}}},"/scim/v2/Users/{id}":{"get":{"operationId":"IntScim_UserGet","summary":"One user.","tags":["SCIM"],"x-scope":"users:read","security":[{"bearer":["users:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"put":{"operationId":"IntScim_UserPut","summary":"Replace a user's attributes.","tags":["SCIM"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"422":{"$ref":"#/components/responses/ScimE422"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"422":["validation_failed"]}},"patch":{"operationId":"IntScim_UserPatch","summary":"Change a user: add, replace, remove.","tags":["SCIM"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimPatch"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScimPatch"}}}},"responses":{"200":{"description":"OK.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"422":{"$ref":"#/components/responses/ScimE422"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"422":["validation_failed"]}},"delete":{"operationId":"IntScim_UserDelete","summary":"Take a user out of the organisation, or withdraw their invitation.","tags":["SCIM"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"204":{"description":"Done. No body."},"400":{"$ref":"#/components/responses/ScimE400"},"401":{"$ref":"#/components/responses/ScimE401"},"403":{"$ref":"#/components/responses/ScimE403"},"404":{"$ref":"#/components/responses/ScimE404"},"405":{"$ref":"#/components/responses/ScimE405"},"429":{"$ref":"#/components/responses/ScimE429"},"500":{"$ref":"#/components/responses/ScimE500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/cases":{"get":{"operationId":"IntCase_List","summary":"The organisation's cases, newest first.","tags":["Cases"],"x-scope":"cases:read","security":[{"bearer":["cases:read"]}],"parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/UpdatedSince"}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Case"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"post":{"operationId":"IntCase_Create","summary":"Open a case under your own reference; the same external_ref again answers the same case.","tags":["Cases"],"x-scope":"cases:write","security":[{"bearer":["cases:write"]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseCreate"}}}},"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Case"}}}}}},"201":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Case"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused"]}}},"/v1/cases/{id}":{"get":{"operationId":"IntCase_Get","summary":"One case.","tags":["Cases"],"x-scope":"cases:read","security":[{"bearer":["cases:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Case"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/cases/{id}/conversations":{"post":{"operationId":"IntCase_StartConversation","summary":"The address a signed-in member opens to start a conversation in the case.","tags":["Cases"],"x-scope":"cases:write","security":[{"bearer":["cases:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CaseUrl"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["case_closed","idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused"]}}},"/v1/conversations":{"get":{"operationId":"IntConv_List","summary":"The organisation's conversations, newest first.","tags":["Conversations"],"x-scope":"conversations:read","security":[{"bearer":["conversations:read"]}],"parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/UpdatedSince"}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/conversations/{id}":{"get":{"operationId":"IntConv_Get","summary":"One conversation.","tags":["Conversations"],"x-scope":"conversations:read","security":[{"bearer":["conversations:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The conversation's id: 32 lowercase hex characters."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Conversation"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/conversations/{id}/facts":{"get":{"operationId":"IntConv_Facts","summary":"The facts the conversation recorded.","tags":["Conversations"],"x-scope":"conversations:read","security":[{"bearer":["conversations:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The conversation's id: 32 lowercase hex characters."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Fact"}}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/conversations/{id}/summary":{"get":{"operationId":"IntConv_Summary","summary":"The conversation's summary, where conversation review is on.","tags":["Conversations"],"x-scope":"summaries:read","security":[{"bearer":["summaries:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The conversation's id: 32 lowercase hex characters."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Summary"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/conversations/{id}/transcript":{"get":{"operationId":"IntConv_Transcript","summary":"The transcript, in both languages, turn by turn.","tags":["Conversations"],"x-scope":"conversations:read","security":[{"bearer":["conversations:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The conversation's id: 32 lowercase hex characters."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Turn"}}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/documents":{"post":{"operationId":"IntDoc_Create","summary":"Send a document or text in a case for translation.","tags":["Documents"],"x-scope":"documents:write","security":[{"bearer":["documents:write"]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DocumentCreateForm"}},"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateText"}}}},"responses":{"202":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"413":{"$ref":"#/components/responses/E413"},"415":{"$ref":"#/components/responses/E415"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused"],"413":["file_too_large","text_too_long"],"415":["file_type_not_supported"]}}},"/v1/documents/{id}":{"get":{"operationId":"IntDoc_Get","summary":"A document sent through the API, and its translation once done.","tags":["Documents"],"x-scope":"documents:read","security":[{"bearer":["documents:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/groups":{"get":{"operationId":"IntGroup_List","summary":"The organisation's groups, newest first.","tags":["Groups"],"x-scope":"groups:read","security":[{"bearer":["groups:read"]}],"parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"post":{"operationId":"IntGroup_Create","summary":"Make a group.","tags":["Groups"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreate"}}}},"responses":{"201":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed","permission_not_grantable"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused","unknown_permission"]}}},"/v1/groups/{id}":{"get":{"operationId":"IntGroup_Get","summary":"One group.","tags":["Groups"],"x-scope":"groups:read","security":[{"bearer":["groups:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"patch":{"operationId":"IntGroup_Update","summary":"Edit a group; permissions, when given, replace the list.","tags":["Groups"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdate"}}}},"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed","permission_not_grantable"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["last_people_manager"],"422":["validation_failed","unknown_permission"]}},"delete":{"operationId":"IntGroup_Delete","summary":"Delete a group; its members keep their accounts.","tags":["Groups"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"204":{"description":"Done. No body."},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["group_holds_cases","last_people_manager"]}}},"/v1/groups/{id}/permissions":{"get":{"operationId":"IntGroup_Permissions","summary":"A group's permission codes.","tags":["Groups"],"x-scope":"groups:read","security":[{"bearer":["groups:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"put":{"operationId":"IntGroup_SetPermissions","summary":"Replace a group's permissions.","tags":["Groups"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsSet"}}}},"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed","permission_not_grantable"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["last_people_manager"],"422":["validation_failed","unknown_permission"]}},"post":{"operationId":"IntGroup_AddPermission","summary":"Add one permission to a group.","tags":["Groups"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionAdd"}}}},"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed","permission_not_grantable"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused","unknown_permission"]}}},"/v1/groups/{id}/permissions/{code}":{"delete":{"operationId":"IntGroup_RemovePermission","summary":"Take one permission off a group.","tags":["Groups"],"x-scope":"groups:write","security":[{"bearer":["groups:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."},{"name":"code","in":"path","required":true,"schema":{"type":"string"},"description":"A permission code."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["last_people_manager"],"422":["validation_failed","unknown_permission"]}}},"/v1/invitations":{"get":{"operationId":"IntUser_Invitations","summary":"Invitations not yet answered.","tags":["People"],"x-scope":"users:read","security":[{"bearer":["users:read"]}],"parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/invitations/{id}":{"delete":{"operationId":"IntUser_WithdrawInvitation","summary":"Withdraw an invitation.","tags":["People"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"204":{"description":"Done. No body."},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/me":{"get":{"operationId":"IntApi_Me","summary":"The connection the key belongs to.","tags":["Connection"],"x-scope":null,"security":[{"bearer":[]}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Me"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/openapi.json":{"get":{"operationId":"openapi","summary":"This description, as JSON. Needs no key.","tags":["Description"],"security":[],"responses":{"200":{"description":"The OpenAPI 3.1 document.","content":{"application/json":{"schema":{"type":"object"}}}},"304":{"description":"Not modified: the ETag sent in If-None-Match is current."}}}},"/v1/permissions":{"get":{"operationId":"IntGroup_PermissionList","summary":"The permission codes there are, with their names.","tags":["Groups"],"x-scope":"groups:read","security":[{"bearer":["groups:read"]}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/users":{"get":{"operationId":"IntUser_List","summary":"The organisation's people, newest first.","tags":["People"],"x-scope":"users:read","security":[{"bearer":["users:read"]}],"parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/UpdatedSince"}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"post":{"operationId":"IntUser_Create","summary":"Add a person by address: created, invited, or already here.","tags":["People"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCreate"}}}},"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Person"}}}}}},"201":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["status","data"],"additionalProperties":false,"properties":{"status":{"const":"created"},"data":{"$ref":"#/components/schemas/Person"}}}}}},"202":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["status","data"],"additionalProperties":false,"properties":{"status":{"const":"invited"},"data":{"$ref":"#/components/schemas/Invitation"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed","permission_not_grantable"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["in_another_organisation","idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused"]}}},"/v1/users/{id}":{"get":{"operationId":"IntUser_Get","summary":"One person.","tags":["People"],"x-scope":"users:read","security":[{"bearer":["users:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Person"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"patch":{"operationId":"IntUser_Update","summary":"Edit a person: name, job title, group, disabled.","tags":["People"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonUpdate"}}}},"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Person"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed","permission_not_grantable"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["last_people_manager"],"422":["validation_failed"]}},"delete":{"operationId":"IntUser_Delete","summary":"Take a person out of the organisation; the account remains.","tags":["People"],"x-scope":"users:write","security":[{"bearer":["users:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"204":{"description":"Done. No body."},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["last_people_manager"]}}},"/v1/webhooks":{"get":{"operationId":"IntHook_List","summary":"The connection's webhooks.","tags":["Webhooks"],"x-scope":"webhooks:manage","security":[{"bearer":["webhooks:manage"]}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"post":{"operationId":"IntHook_Create","summary":"Add a webhook; its secret is in this answer only.","tags":["Webhooks"],"x-scope":"webhooks:manage","security":[{"bearer":["webhooks:manage"]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}}},"responses":{"201":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/WebhookCreated"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused"]}}},"/v1/webhooks/{id}":{"get":{"operationId":"IntHook_Get","summary":"One webhook.","tags":["Webhooks"],"x-scope":"webhooks:manage","security":[{"bearer":["webhooks:manage"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Webhook"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}},"delete":{"operationId":"IntHook_Delete","summary":"Remove a webhook.","tags":["Webhooks"],"x-scope":"webhooks:manage","security":[{"bearer":["webhooks:manage"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."}],"responses":{"204":{"description":"Done. No body."},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"]}}},"/v1/webhooks/{id}/test":{"post":{"operationId":"IntHook_Test","summary":"Send the webhook a signed webhook.test event now, and how its address answered. One every 5 seconds.","tags":["Webhooks"],"x-scope":"webhooks:manage","security":[{"bearer":["webhooks:manage"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An id: a string of digits."},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"OK.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/WebhookTest"}}}}}},"400":{"$ref":"#/components/responses/E400"},"401":{"$ref":"#/components/responses/E401"},"403":{"$ref":"#/components/responses/E403"},"404":{"$ref":"#/components/responses/E404"},"405":{"$ref":"#/components/responses/E405"},"409":{"$ref":"#/components/responses/E409"},"422":{"$ref":"#/components/responses/E422"},"429":{"$ref":"#/components/responses/E429"},"500":{"$ref":"#/components/responses/E500"}},"x-error-codes":{"400":["invalid_request"],"401":["unauthorised"],"403":["module_off","scope_missing","ip_not_allowed"],"404":["not_found"],"405":["method_not_allowed"],"429":["rate_limited"],"500":["server_error"],"409":["idempotency_key_in_use"],"422":["validation_failed","idempotency_key_reused"]}}}},"webhooks":{"conversation.ended":{"post":{"summary":"A conversation in the organisation ended.","description":"Signed: InMyWords-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook's secret>. Answer 2xx within 10 seconds. Ids only, never words. Needs the connection to hold conversations:read.","parameters":[{"name":"InMyWords-Signature","in":"header","required":true,"schema":{"type":"string","pattern":"^t=\\d+,v1=[0-9a-f]{64}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"event":{"const":"conversation.ended"},"data":{"type":"object","required":["conversation_id"],"additionalProperties":false,"properties":{"conversation_id":{"type":"string"}}}}}]}}}},"responses":{"2XX":{"description":"Received."}}}},"summary.ready":{"post":{"summary":"A conversation's summary was written or rewritten.","description":"Signed: InMyWords-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook's secret>. Answer 2xx within 10 seconds. Ids only, never words. Needs the connection to hold summaries:read.","parameters":[{"name":"InMyWords-Signature","in":"header","required":true,"schema":{"type":"string","pattern":"^t=\\d+,v1=[0-9a-f]{64}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"event":{"const":"summary.ready"},"data":{"type":"object","required":["conversation_id"],"additionalProperties":false,"properties":{"conversation_id":{"type":"string"}}}}}]}}}},"responses":{"2XX":{"description":"Received."}}}},"document.translated":{"post":{"summary":"A document sent through the API was translated.","description":"Signed: InMyWords-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook's secret>. Answer 2xx within 10 seconds. Ids only, never words. Needs the connection to hold documents:read.","parameters":[{"name":"InMyWords-Signature","in":"header","required":true,"schema":{"type":"string","pattern":"^t=\\d+,v1=[0-9a-f]{64}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"event":{"const":"document.translated"},"data":{"type":"object","required":["document_id","case_id","language"],"additionalProperties":false,"properties":{"document_id":{"type":"string"},"case_id":{"type":"string"},"language":{"type":"string"}}}}}]}}}},"responses":{"2XX":{"description":"Received."}}}},"user.joined":{"post":{"summary":"A person invited through the API accepted.","description":"Signed: InMyWords-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook's secret>. Answer 2xx within 10 seconds. Ids only, never words. Needs the connection to hold users:read.","parameters":[{"name":"InMyWords-Signature","in":"header","required":true,"schema":{"type":"string","pattern":"^t=\\d+,v1=[0-9a-f]{64}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"event":{"const":"user.joined"},"data":{"type":"object","required":["user_id"],"additionalProperties":false,"properties":{"user_id":{"type":"string"}}}}}]}}}},"responses":{"2XX":{"description":"Received."}}}},"webhook.test":{"post":{"summary":"Sent only when a test of one webhook is asked for.","description":"Signed: InMyWords-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook's secret>. Answer 2xx within 10 seconds. Ids only, never words.","parameters":[{"name":"InMyWords-Signature","in":"header","required":true,"schema":{"type":"string","pattern":"^t=\\d+,v1=[0-9a-f]{64}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"event":{"const":"webhook.test"},"data":{"type":"object","required":["webhook_id","connection_id"],"additionalProperties":false,"properties":{"webhook_id":{"type":"string"},"connection_id":{"type":"string"}}}}}]}}}},"responses":{"2XX":{"description":"Received."}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"imw_ followed by 64 hex characters","description":"The connection's key. Each operation names the scope it needs in x-scope and in its security requirement."}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"ScimError":{"type":"object","required":["schemas","status"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"scimType":{"type":"string"},"detail":{"type":"string"}}},"Me":{"type":"object","required":["connection_id","name","organisation","scopes","created_at"],"properties":{"connection_id":{"type":"string"},"name":{"type":"string"},"organisation":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"scopes":{"type":"array","items":{"type":"string"}},"created_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"Conversation":{"type":"object","required":["id","started_at","ended_at","languages","case_id","group","operator","turn_count","has_summary"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"started_at":{"type":["string","null"],"format":"date-time"},"ended_at":{"type":["string","null"],"format":"date-time"},"languages":{"type":"object","required":["operator","service_user"],"properties":{"operator":{"type":"string"},"service_user":{"type":["string","null"]}},"additionalProperties":false},"case_id":{"type":["string","null"]},"group":{"type":["object","null"],"required":["id","name"],"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"operator":{"type":["object","null"],"required":["id","display_name"],"additionalProperties":false,"properties":{"id":{"type":"string"},"display_name":{"type":["string","null"]}}},"turn_count":{"type":"integer"},"has_summary":{"type":"boolean"}},"additionalProperties":false},"Turn":{"type":"object","required":["speaker","said","shown","score","said_at"],"properties":{"speaker":{"type":"string","enum":["operator","service_user"]},"said":{"type":"object","required":["text","language"],"properties":{"text":{"type":"string"},"language":{"type":"string"}},"additionalProperties":false},"shown":{"type":["object","null"],"required":["text","language"],"additionalProperties":false,"properties":{"text":{"type":"string"},"language":{"type":"string"}}},"score":{"type":["integer","null"]},"said_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"Fact":{"type":"object","required":["key","category","value","set_at"],"properties":{"key":{"type":"string"},"category":{"type":"string"},"value":{"type":"string"},"set_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"Summary":{"type":"object","required":["text","language","written_at"],"properties":{"text":{"type":"string"},"language":{"type":"string"},"written_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"Case":{"type":"object","required":["id","title","reference","external_ref","group","created_at","updated_at","closed_at","conversation_count","url"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"reference":{"type":"string"},"external_ref":{"type":["string","null"]},"group":{"type":"object","required":["id","name"],"properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]}},"additionalProperties":false},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"closed_at":{"type":["string","null"],"format":"date-time"},"conversation_count":{"type":"integer"},"url":{"type":"string","format":"uri"}},"additionalProperties":false},"CaseCreate":{"type":"object","required":["title","external_ref"],"properties":{"title":{"type":"string","maxLength":160},"external_ref":{"type":"string","maxLength":128},"reference":{"type":"string","maxLength":64},"group_id":{"type":["string","integer","null"]}},"additionalProperties":false},"CaseUrl":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"}},"additionalProperties":false},"Document":{"type":"object","required":["id","case_id","file_name","status","source_language","target_language","created_at","translated_at","blocks"],"properties":{"id":{"type":"string"},"case_id":{"type":"string"},"file_name":{"type":"string"},"status":{"type":"string","enum":["queued","translating","waiting","translated","failed"]},"source_language":{"type":["string","null"]},"target_language":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"translated_at":{"type":["string","null"],"format":"date-time"},"blocks":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Block"}}},"additionalProperties":false},"Block":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["heading","paragraph","list_item","table_cell"]},"text":{"type":"string"},"level":{"type":"integer","minimum":1}},"additionalProperties":false},"DocumentCreateForm":{"type":"object","required":["case_id","target_language"],"properties":{"case_id":{"type":"string"},"target_language":{"type":"string"},"file":{"type":"string","contentMediaType":"application/octet-stream"},"text":{"type":"string","maxLength":400000}},"additionalProperties":false},"DocumentCreateText":{"type":"object","required":["case_id","target_language","text"],"properties":{"case_id":{"type":["string","integer"]},"target_language":{"type":"string"},"text":{"type":"string","maxLength":400000}},"additionalProperties":false},"Person":{"type":"object","required":["id","email","display_name","job_title","group_id","disabled","last_sign_in","joined_at"],"properties":{"id":{"type":"string"},"email":{"type":"string"},"display_name":{"type":["string","null"]},"job_title":{"type":["string","null"]},"group_id":{"type":["string","null"]},"disabled":{"type":"boolean"},"last_sign_in":{"type":["string","null"],"format":"date-time"},"joined_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"PersonCreate":{"type":"object","required":["email"],"properties":{"email":{"type":"string","maxLength":254},"display_name":{"type":"string","maxLength":120},"job_title":{"type":"string","maxLength":120},"group_id":{"type":["string","integer","null"]}},"additionalProperties":false},"PersonUpdate":{"type":"object","required":[],"properties":{"display_name":{"type":["string","null"],"maxLength":120},"job_title":{"type":["string","null"],"maxLength":120},"group_id":{"type":["string","integer","null"]},"disabled":{"type":["boolean","null"]}},"additionalProperties":false},"Invitation":{"type":"object","required":["id","email","invited_at","expires_at"],"properties":{"id":{"type":"string"},"email":{"type":"string"},"invited_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"Group":{"type":"object","required":["id","name","description","permissions","require_two_factor","allow_hide_templates","member_count","created_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"permissions":{"type":"array","items":{"type":"string"}},"require_two_factor":{"type":"boolean"},"allow_hide_templates":{"type":"boolean"},"member_count":{"type":"integer"},"created_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"GroupCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":120},"description":{"type":"string","maxLength":500},"permissions":{"type":"array","items":{"type":"string"}},"require_two_factor":{"type":"boolean"},"allow_hide_templates":{"type":"boolean"}},"additionalProperties":false},"GroupUpdate":{"type":"object","required":[],"properties":{"name":{"type":"string","maxLength":120},"description":{"type":["string","null"],"maxLength":500},"permissions":{"type":"array","items":{"type":"string"}},"require_two_factor":{"type":"boolean"},"allow_hide_templates":{"type":"boolean"}},"additionalProperties":false},"PermissionsSet":{"type":"object","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"PermissionAdd":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}},"additionalProperties":false},"Permission":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"Webhook":{"type":"object","required":["id","url","events","created_at","switched_off_at"],"properties":{"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["conversation.ended","summary.ready","document.translated","user.joined"]}},"created_at":{"type":["string","null"],"format":"date-time"},"switched_off_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"WebhookCreated":{"type":"object","required":["id","url","events","secret","created_at","switched_off_at"],"properties":{"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"secret":{"type":["string","null"]},"secret_shown":{"type":"boolean"},"created_at":{"type":["string","null"],"format":"date-time"},"switched_off_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"WebhookCreate":{"type":"object","required":["url","events"],"properties":{"url":{"type":"string","maxLength":500,"pattern":"^https://"},"events":{"type":"array","items":{"type":"string","enum":["conversation.ended","summary.ready","document.translated","user.joined"]}}},"additionalProperties":false},"WebhookTest":{"type":"object","required":["delivery_id","delivered","status","error","duration_ms"],"properties":{"delivery_id":{"type":"string"},"delivered":{"type":"boolean"},"status":{"type":["integer","null"]},"error":{"type":["string","null"]},"duration_ms":{"type":["integer","null"]}},"additionalProperties":false},"WebhookDelivery":{"type":"object","required":["id","event","occurred_at","data"],"properties":{"id":{"type":"string"},"event":{"type":"string","enum":["conversation.ended","summary.ready","document.translated","user.joined","webhook.test"]},"occurred_at":{"type":["string","null"],"format":"date-time"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"ScimAny":{"type":"object"},"ScimUser":{"type":"object","required":["userName"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"externalId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"object"},"title":{"type":"string"},"active":{"type":["boolean","string"]},"emails":{"type":"array"},"groups":{"type":"array"},"meta":{"type":"object"}}},"ScimGroup":{"type":"object","required":["displayName"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"displayName":{"type":"string"},"members":{"type":"array","items":{"type":"object","required":["value"],"properties":{"value":{"type":["string","integer"]}}}},"meta":{"type":"object"}}},"ScimList":{"type":"object","required":["schemas","totalResults","startIndex","itemsPerPage","Resources"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"totalResults":{"type":"integer"},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"},"Resources":{"type":"array","items":{"type":"object"}}}},"ScimPatch":{"type":"object","required":["Operations"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"Operations":{"type":"array","items":{"type":"object","required":["op"],"properties":{"op":{"type":"string","description":"add, replace or remove, in any case."},"path":{"type":"string"},"value":{}}}}}}},"parameters":{"Limit":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"default":50},"description":"Rows a page; above 100 is taken as 100."},"Cursor":{"name":"cursor","in":"query","schema":{"type":"string"},"description":"next_cursor from the page before, as given."},"UpdatedSince":{"name":"updated_since","in":"query","schema":{"type":"string","format":"date-time"},"description":"Only what changed after this UTC time."},"IdempotencyKey":{"name":"Idempotency-Key","in":"header","schema":{"type":"string","maxLength":255},"description":"The same key, address and body within 24 hours answers the first result."},"ScimFilter":{"name":"filter","in":"query","schema":{"type":"string"},"description":"attribute eq \"value\"."},"ScimStartIndex":{"name":"startIndex","in":"query","schema":{"type":"integer","minimum":1,"default":1}},"ScimCount":{"name":"count","in":"query","schema":{"type":"integer","minimum":0}},"ScimExcluded":{"name":"excludedAttributes","in":"query","schema":{"type":"string","enum":["members"]}}},"responses":{"E400":{"description":"The request could not be read: a bad parameter, cursor or body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E401":{"description":"No key was sent, or the key is malformed or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E403":{"description":"Integrations off or the policy not accepted, the scope not held, the address not on the organisation's list, or a permission a connection may not give.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E404":{"description":"No such object in this organisation, or no such address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E405":{"description":"That method is not answered at this address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E409":{"description":"A rule refused the change, or the Idempotency-Key is still being answered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E413":{"description":"Too large: a file over 20 MB or text over 400,000 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E415":{"description":"A file type the organisation cannot send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E422":{"description":"A field is missing or not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E429":{"description":"Too many calls this minute from this connection, or too many refused calls from this address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"E500":{"description":"Something went wrong on our side; X-Request-Id names it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ScimE400":{"description":"The request could not be read: a bad parameter, cursor or body.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE401":{"description":"No key was sent, or the key is malformed or revoked.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE403":{"description":"Integrations off or the policy not accepted, the scope not held, the address not on the organisation's list, or a permission a connection may not give.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE404":{"description":"No such object in this organisation, or no such address.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE405":{"description":"That method is not answered at this address.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE409":{"description":"A rule refused the change, or the Idempotency-Key is still being answered.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE413":{"description":"Too large: a file over 20 MB or text over 400,000 characters.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE415":{"description":"A file type the organisation cannot send.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE422":{"description":"A field is missing or not valid.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE429":{"description":"Too many calls this minute from this connection, or too many refused calls from this address.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"ScimE500":{"description":"Something went wrong on our side; X-Request-Id names it.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}}},"headers":{"RetryAfter":{"description":"Seconds to wait.","schema":{"type":"integer"}},"RequestId":{"description":"16 hex characters naming this request; quote it when asking about a call.","schema":{"type":"string","pattern":"^[0-9a-f]{16}$"}}}}}