Справочник API публикуется на английском языке.

Apply organization import

POST/api/companies/{companyId}/imports/apply
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Apply organization import.

Safe import into this organization only: target must be { mode: "existing_company", companyId } for the route organization or a new organization, and collisionStrategy may be "rename" or "skip" ("replace" is rejected, so an existing agent is never overwritten). nameOverrides maps an incoming agent, project or task slug to the name it should get. Preview never changes the organization; apply creates or reuses resources and returns them.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

sourceobjectОбязательный
includeobjectНеобязательный
include.companybooleanНеобязательный
include.agentsbooleanНеобязательный
include.projectsbooleanНеобязательный
include.issuesbooleanНеобязательный
include.skillsbooleanНеобязательный
targetobjectОбязательный
agentsstring | array<string>Необязательный
collisionStrategystringНеобязательныйone of: "rename", "skip", "replace"
nameOverridesobject<string, string>Необязательный
selectedFilesarray<string>Необязательный
adapterOverridesobject<string, object>Необязательный
secretValuesobject<string, string>Необязательный
pauseAutomationsbooleanНеобязательный

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Organizations