API referansı İngilizce yayımlanır.

Apply organization import

POST/api/companies/{companyId}/imports/apply
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

sourceobjectZorunlu
includeobjectİsteğe bağlı
include.companybooleanİsteğe bağlı
include.agentsbooleanİsteğe bağlı
include.projectsbooleanİsteğe bağlı
include.issuesbooleanİsteğe bağlı
include.skillsbooleanİsteğe bağlı
targetobjectZorunlu
agentsstring | array<string>İsteğe bağlı
collisionStrategystringİsteğe bağlıone of: "rename", "skip", "replace"
nameOverridesobject<string, string>İsteğe bağlı
selectedFilesarray<string>İsteğe bağlı
adapterOverridesobject<string, object>İsteğe bağlı
secretValuesobject<string, string>İsteğe bağlı
pauseAutomationsbooleanİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Organizations