GEO Writer

Crie e faça a gestão de tarefas do GEO Writer com IA. As tarefas são processadas de forma assíncrona, por isso crie uma e faça polling até estar concluída.

POST/intelligence_tasks

Crie uma tarefa do GEO Writer. Dois modos: baseado num prompt (indique prompt_id) ou agêntico (indique custom_topic e/ou user_instructions). O tipo product_listing recebe, em vez disso, um objeto product e devolve texto de página de produto pronto a aplicar.

Corpo (JSON):
  • project_idobrigatório
  • task_typeobrigatório: brief, create, update, pr_insights, custom, product_listing
  • prompt_id
  • custom_topic
  • user_instructions
  • output_language_code
  • existing_content
  • existing_content_url

Apenas para product_listing: product (obrigatório: title, além de external_id, description_html, seo_title, seo_description, url, product_type e até 20 images com id e alt) e prompt_ids (até 20 prompts do projeto para os quais orientar o texto). O result_data da tarefa concluída inclui summary, description_html, faq, seo_title, seo_description, image_alts e changes.

GET/intelligence_tasks

Liste as tarefas do GEO Writer de um projeto com filtragem opcional.

Parâmetros:
  • project_idobrigatório
  • task_type
  • statuspending|processing|review|completed|in_progress|blocked|discarded
  • page
  • per_page

As tarefas descartadas nunca são listadas, pelo que status=discarded devolve uma página vazia.

GET/intelligence_tasks/:id

Obtenha os detalhes completos da tarefa, incluindo os dados do resultado quando estiver concluída. Aceita o ID numérico ou o public_id.

Parâmetros:
  • project_idobrigatório
  • :idID da tarefa ou public_id no URL

PATCH/intelligence_tasks/:id

Edite blocos de texto existentes de uma tarefa concluída sem a regenerar. Cada chave de edits é um caminho com pontos para um valor de texto de result_data (por exemplo, sections.0.content) e só é possível alterar texto existente. Um valor igual ao texto guardado é ignorado e a primeira edição guarda uma cópia da versão de IA para que possa ser restaurada.

Corpo (JSON):
  • project_idobrigatório
  • :idID da tarefa ou public_id no URL
  • editsobrigatório, objeto que associa caminhos em notação de pontos ao novo texto

Requer uma chave de API com âmbito de escrita.

result_version (opcional): envie o result_version devolvido quando leu a tarefa. Se a tarefa tiver sido regenerada entretanto, a edição é recusada com ERR_STALE_CONTENT (HTTP 409) e nada é guardado: leia a tarefa novamente e reenvie as suas edições. Sem este parâmetro, as edições aplicam-se ao conteúdo que a tarefa tiver no momento do pedido.

POST/intelligence_tasks/:id/revert

Descarta todas as edições manuais e restaura a versão de IA guardada na primeira edição. Devolve ERR_INVALID_PARAM quando a tarefa não tem edições manuais.

Parâmetros:
  • project_idobrigatório
  • :idID da tarefa ou public_id no URL

Requer uma chave de API com âmbito de escrita.

GET/cms/content

Lista os artigos ou as páginas do site WordPress ligado ao projeto nas Definições do projeto, a começar pela alteração mais recente. O site responde em tempo real e nada é guardado. Os títulos são texto simples obtido do site.

Parâmetros:
  • project_idobrigatório
  • typepost ou page
  • statuspublish, future, draft, pending, private ou any
  • search
  • page
  • per_pagemáximo 50

Devolve ERR_CMS_NOT_CONNECTED ou ERR_CMS_ACCESS_REVOKED com meta.connect_url quando é necessário ligar ou voltar a ligar o site.

GET/cms/content/:id

Obtém um artigo ou uma página do site WordPress ligado, pelo respetivo ID do WordPress. O conteúdo é sanitizado e mantém apenas títulos, parágrafos, listas, tabelas, citações, código e links; as imagens, os scripts e os elementos incorporados são removidos.

Parâmetros:
  • project_idobrigatório
  • :idID do WordPress no URL
  • typepost ou page

POST/intelligence_tasks/:id/send_to_cms

Envia um artigo ou uma atualização de conteúdo concluídos para o site WordPress ligado, como um novo rascunho. Nada é publicado e nenhum artigo existente é editado. O rascunho é criado em segundo plano; o cms_drafts da tarefa indica o respetivo estado e o link de edição. Se a mesma versão for enviada novamente, é devolvido o rascunho existente.

Parâmetros:
  • project_idobrigatório
  • :idID da tarefa ou public_id no URL

Requer uma chave de API com âmbito de escrita. Não disponível em hosts de portais de marca branca.