Skip to main content

HTTP and JSON

warning

Using Python SDK or one of the supported client libraries is the recommended way to interact with detoxio.ai APIs.

Our API servers use ConnectRPC for implementation which supports JSON based request and response format over HTTP/1.1, HTTP/2 and HTTP/3. For more details, refer to ConnectRPC multi-protocol support.

Authentication​

You will need an API key to access the APIs below. Refer to API Authentication for more details. Once you have the API key, export it in the environment variable

export DETOXIO_API_KEY=<your-api-key>

Prompts Service​

Generate a Prompt​

curl -s \
  --header "Content-Type: application/json" \
  --header "Authorization: $DETOXIO_API_KEY" \
  --data '{"count": "1"}' \
  https://api.detoxio.ai/dtx.services.prompts.v1.PromptService/GeneratePrompts

Evaluate a Prompt Response​

curl -s \
    --header "Content-Type: application/json" \
    --header "Authorization: $DETOXIO_API_KEY" \
    --data '
    {
      "prompt": {"data": {"content": "I am a prompt generated by detoxio.ai"}},
      "responses": [
        {"message": {"content": "I am a response from an LLM"}}
      ]
    }
    ' \
    https://api.detoxio.ai/dtx.services.prompts.v1.PromptService/EvaluateModelInteraction