Documentos

Notas
Nivel experto
La clave API debe enviarse como un token de portador en el encabezado de autorización de la solicitud. Obtenga su clave API.
Lista

API endpoint:

GET 
https://artiro.app/api/v1/documents

Solicitar ejemplo: 

curl --location --request GET 'https://artiro.app/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametro
Tipo
Descripción
search
opcional string
Consulta de busqueda.
search_by
opcional string
Buscar por. Posibles valores son: :valor para Nombre, :valor para Resultado. Predeterminado: name.
template_id
opcional integer
Fltrar por ID de plantilla. Posibles valores son: :valor para Estilo libre, :valor para Sobre nosotros, :valor para Publicidad, :valor para Articulo, :valor para Blog intro, :valor para Resumen del blog, :valor para Blog final, :valor para Blog parrafo, :valor para Entrada en el blog, :valor para Blog sección, :valor para Temas de debate del blog, :valor para Blog titulo, :valor para Llamada a la acción, :valor para Reescritura de contenido, :valor para Resumen de contenido, :valor para FAQ, :valor para Hashtags, :valor para Encabezado, :valor para Como funciona, :valor para Meta descripción, :valor para Meta keywords, :valor para Declaración de objetivos, :valor para Newsletter, :valor para Problema-Agitación-Solución, :valor para Parrafo, :valor para Comunicados de prensa, :valor para Social post, :valor para Post sociales de captación, :valor para Ideas de Startup, :valor para Nombre de startups, :valor para Subtitulado, :valor para Testimonios, :valor para Cita de redes sociales, :valor para Biografía de las redes sociales, :valor para Propuestas de valor, :valor para Descripción de videos, :valor para Guión de video, :valor para Video etiquetas, :valor para Titulos de videos, :valor para Declaración de visión, :valor para Hoja de producto, :valor para Correo electrónico de bienvenida, :valor para Notificación Push, :valor para Lista de blog, :valor para Gramática del contenido, :valor para Etiquetas de blog, :valor para Pros y contras, :valor para Anuncio en Google, :valor para Anuncio en Facebook, :valor para Descripción del trabajo, :valor para Revisar, :valor para Sección de características, :valor para Articulo SEO, :valor para Propuesta para cliente potencial, :valor para Actuar como una hoja Excel, :valor para Actuar como «Storyteller», :valor para Desarrollador UX/UI, :valor para Influyente en las redes sociales, :valor para Marketing de contenidos. Predeterminado: freestyle.
favorite
opcional boolean
Filtrar por favorito.
sort_by
opcional string
Ordenadar por. Posibles valores son: :valor para Fecha de creación, :valor para Nombre. Predeterminado: id.
sort
opcional string
Clasificador. Posibles valores son: :valor para Descendiente, :valor para Ascendiente. Predeterminado: desc.
per_page
opcional integer
Resultados por página. Posibles valores son: 10, 25, 50, 100. Predeterminado: 10.
Show

API endpoint:

GET 
https://artiro.app/api/v1/documents/{id}

Solicitar ejemplo: 

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

API endpoint:

POST 
https://artiro.app/api/v1/documents

Solicitar ejemplo: 

curl --location --request POST 'https://artiro.app/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Parametro
Tipo
Descripción
name
requierido string
El nombre del documento.
prompt
requierido string
Instrucciones para Artiro (IA).
creativity
requierido float
El nivel creativo del resultado. Posibles valores son: :valor para Repetitivo, :valor para Determinista, :valor para Original, :valor para Creativo, :valor para Imaginativo. Predeterminado: 0.5.
Actualizar

API endpoint:

PUT PATCH 
https://artiro.app/api/v1/documents/{id}

Solicitar ejemplo: 

curl --location --request PUT 'https://artiro.app/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametro
Tipo
Descripción
name
opcional string
El nombre del documento.
result
opcional string
Resultado del documento.
favorite
opcional boolean
El documento es favorito o no.
Eliminar

API endpoint:

DELETE 
https://artiro.app/api/v1/documents/{id}

Solicitar ejemplo: 

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