/v1/scrape

OPTIONS <baseUrl>/v1/scrape

OPTIONS Options for scrape

Responses

200 Options successful. Returns allowed HTTP methods.
application/json
{
  "allow": [
    "POST",
    "OPTIONS"
  ]
}

POST Scrape API Documentation

Ingest public API documentation from a specified URL. Vaktum will attempt to extract an OpenAPI specification or relevant endpoint details from the provided documentation.

Request Body

Required
application/json
Schema: ScrapeRequest
publicApi - Public API documentation URL
{
  "url": "https://public.api.com/docs"
}
redocExample - ReDoc URL
{
  "url": "https://redocly.github.io/redoc/"
}
swaggerExample - Swagger UI URL
{
  "url": "https://petstore.swagger.io/"
}

Responses

200 Scrape successful. Returns the extracted data or generated OpenAPI specification.
application/json
Schema: ScrapeResponse
endpointsExtracted - Extracted Endpoints
{
  "endpoints": [
    {
      "description": "List all users",
      "method": "GET",
      "path": "/users"
    },
    {
      "description": "Get user by ID",
      "method": "GET",
      "path": "/users/{id}"
    }
  ],
  "format": "endpoints"
}
openapiExtracted - Extracted OpenAPI JSON
{
  "data": "{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Sample API\",\"version\":\"1.0.0\"},\"paths\":{}}",
  "format": "openapi",
  "version": "3.0.0"
}
400 Bad request - invalid URL or unreachable documentation
application/json
Schema: ErrorResponse
{
  "detail": "Could not access the provided documentation URL",
  "error": "Invalid URL"
}
401 Unauthorized
429 Too many requests - rate limit exceeded
500 Internal server error

Security

  • apiKeyAuth [apiKey]
    API Key authentication. Use the X-API-KEY header (generated from the Vaktum portal) to authenticate directly to a workspace.
    In: header
    Name: X-API-KEY
  • bearerAuth [http]
    OAuth2 authentication. Use the Authorization header with a Bearer token. Also provide X-WORKSPACE-ID header for workspace context.
    Scheme: bearer
    Bearer Format: JWT