Справочник API публикуется на английском языке.
Finish a gallery app connection and profile setup
POST
/api/companies/{companyId}/tools/apps/{connectionId}/finishPersonal API keyAgent API keyConsole session
Finish a gallery app connection and profile setup.
Авторизация
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.
connectionIdstringОбязательныйThe connection's id.
Тело запроса
application/json · обязательно
agentInstructionsobject | nullНеобязательный
agentInstructions.enabledbooleanОбязательный
agentInstructions.textstringОбязательный
1–2000 charactersagentInstructions.templateobjectНеобязательный
agentInstructions.template.idstringОбязательный
1–160 charactersagentInstructions.template.versionintegerОбязательный
> 0preserveExistingAccessbooleanНеобязательный
enabledCatalogEntryIdsarray<string (uuid)>Необязательный
askFirstCatalogEntryIdsarray<string (uuid)>Необязательный
reviewedCatalogEntryIdsarray<string (uuid)>Необязательный
accessstring | objectОбязательный
Ответы
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.