Especificação OpenAPI

Baixe a especificação OpenAPI 3.1 da API e dos webhooks para gerar clientes e testar.

GEThttps://livetp.app/api/v1/openapi

A especificação descreve todos os endpoints de /api/v1, os schemas de roteiro e erro, os esquemas de segurança (chave e OAuth) e, na seção webhooks, o formato de cada evento. É pública, não exige autenticação e não contém dados pessoais.

Os endereços do documento seguem o ambiente consultado: a especificação de staging aponta para https://staging.livetp.app.

Usos comuns

Gerar clientes com OpenAPI Generator ou openapi-typescript.
Importar no Postman, Insomnia, Bruno ou Hoppscotch para testar chamadas.
Validar payloads de webhook no seu receptor a partir dos schemas.
Dar contexto a agentes de IA que geram código de integração.

Requisição

curl 'https://livetp.app/api/v1/openapi' -o livetp-openapi.json

Resposta

{
  "openapi": "3.1.0",
  "info": {
    "title": "LiveTP API",
    "version": "1.0.0"
  },
  "servers": [{ "url": "https://livetp.app/api/v1" }],
  "paths": {
    "/me": {},
    "/scripts": {},
    "/scripts/library": {},
    "/scripts/{id}": {},
    "/scripts/{id}/restore": {}
  },
  "webhooks": {
    "script.created": {},
    "script.updated": {}
  }
}

Especificação OpenAPI

Usos comunsCopiar link da seção

Usos comuns