Documentos

Notas
Nivel experto
La clave API debe enviarse como un token de portador en la cabecera de autorización de la solicitud. Consigue tu clave API.
Lista

Punto final de la API:

GET
https://aisistente.com/api/v1/documents

Ejemplo de solicitud:

curl --location --request GET 'https://aisistente.com/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
search
opcional string
La consulta de búsqueda.
search_by
opcional string
Buscar por. Los valores posibles son: :valores. Por defecto: :valor.
template_id
opcional integer
Filtrar por ID de plantilla. Los valores posibles son: :valores. Por defecto: :valor.
favorite
opcional boolean
Filtrar por favorito.
sort_by
opcional string
Ordenar por. Los valores posibles son: :valores. Por defecto: :valor.
sort
opcional string
Clasificar. Los valores posibles son: :valores. Por defecto: :valor.
per_page
opcional integer
Resultados por página. Los valores posibles son: :valores. Por defecto: :valor.
Mostrar

Punto final de la API:

GET
https://aisistente.com/api/v1/documents/{id}

Ejemplo de solicitud:

curl --location --request GET 'https://aisistente.com/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Tienda

Punto final de la API:

POST
https://aisistente.com/api/v1/documents

Ejemplo de solicitud:

curl --location --request POST 'https://aisistente.com/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Parámetro
Tipo
Descripción
name
necesario string
The document name.
prompt
necesario string
Las instrucciones para la IA.
creativity
necesario float
The creative level of the result. Los valores posibles son: :valores. Por defecto: :valor.
Actualiza

Punto final de la API:

PUT PATCH
https://aisistente.com/api/v1/documents/{id}

Ejemplo de solicitud:

curl --location --request PUT 'https://aisistente.com/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
name
opcional string
The document name.
result
opcional string
El resultado del documento.
favorite
opcional boolean
Si el documento es favorito o no.
Borra

Punto final de la API:

DELETE
https://aisistente.com/api/v1/documents/{id}

Ejemplo de solicitud:

curl --location --request DELETE 'https://aisistente.com/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'