Crear API Key

Permite al propietario de la organización crear una API Key para un Agent o Workflow de la organización.

Mediante este endpoint puede emitir una nueva API Key para un Agent o Workflow específico y definir si la clave tiene permiso de gestión de versiones. Una vez creada, puede usar la API Key devuelta para llamar a los endpoints de nivel de recurso de ese Agent o Workflow.

Método de solicitud

POST

URL de la solicitud

https://api.${endpoint}/v1/org/api-key/create

Autenticación de la solicitud

Utiliza autenticación Basic con DevKey / DevSecret a nivel de cuenta, y la cuenta que realiza la llamada debe ser la propietaria de la organización.

Solicitud

Ejemplo de solicitud

curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0", "is_publish": true }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0",
    "is_publish": true
  }'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Basic ${BASIC_TOKEN}	Basic Token resultante de codificar `DevKey:DevSecret` en Base64.
Content-Type	application/json	Formato del cuerpo de la solicitud.

Parámetros de la solicitud (Body Parameters)

Campo	Tipo	Descripción	Obligatorio
org_id	String	ID de la organización, que puede obtenerse mediante el endpoint Consultar lista de organizaciones.	true
agent_id	String	ID del Agent para el que se crea la API Key. Excluyente con `workflow_id`; solo se puede indicar uno de los dos.	false
workflow_id	String	ID del Workflow para el que se crea la API Key. Excluyente con `agent_id`; solo se puede indicar uno de los dos.	false
is_publish	Boolean	Indica si se habilita el permiso de gestión de versiones (importación, lista de versiones, publicación, reversión) para esta API Key. Solo establece el permiso y no desencadena ninguna publicación. Debe ser un booleano JSON `true` o `false`; no se admiten valores como `"true"` o `1`.	true

Notas:

Se debe indicar exactamente un valor no vacío en agent_id o workflow_id. Si se indican ambos, ninguno o una cadena en blanco, se devuelve un error de parámetros.
El ID debe coincidir con el tipo de recurso: si se pasa un ID de Workflow en agent_id, o un ID de Agent en workflow_id, se devuelve un error de tipo no coincidente.
Cada Agent o Workflow puede tener como máximo 10 API Keys. Al alcanzar el límite, elimine una clave existente antes de crear una nueva.
El nombre de la nueva API Key se genera automáticamente con el formato api- seguido de 12 caracteres aleatorios. Puede consultarlo o modificarlo en la página de claves de API de la consola.
Este endpoint tiene límite de frecuencia por cuenta: como máximo 10 llamadas por minuto y cuenta.

Respuesta

Ejemplo de respuesta

{ "code": 0, "message": "OK", "data": { "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
api_key	String	La API Key recién creada, utilizada para llamar a los endpoints de nivel de recurso del Agent o Workflow correspondiente.

Guarde la API Key devuelta de forma segura. La respuesta incluye la cabecera Cache-Control: no-store; no conserve la clave en texto plano en registros ni cachés.

Respuesta fallida

Campo	Tipo	Descripción
code	Integer	Código de error.
message	String	Detalles del error.

Códigos de error

Código de error	Descripción
40000	Error de parámetros, por ejemplo: falta un parámetro obligatorio, `is_publish` no es booleano, `agent_id` y `workflow_id` no cumplen la regla de indicar exactamente uno, o el recurso ha alcanzado el límite de API Keys.
40101	La cabecera `Authorization` de la solicitud está vacía.
40104	La cuenta actual no es la propietaria de la organización.
40324	DevKey o DevSecret incorrectos.
40348	El Agent o Workflow no existe o no pertenece a la organización.
403204	El ID indicado no coincide con el tipo de recurso (Agent / Workflow).

Códigos de estado

Código de estado	Descripción
200	Correcto
400	Error de parámetros
401	No autorizado
403	Permisos insuficientes
429	Demasiadas solicitudes
500	Error del servidor