API-TESTING.md

Form Fill Agent API Documentation

This document provides detailed information about the Form Fill Agent API endpoints, including example requests and responses.

Note: For more detailed curl commands with real-world examples and complete workflows, see CURL-CALLS.md.

Base URL

http://localhost:8000

Endpoints

1. Start Form Filler Agent

Starts the form filler agent with user information.

Endpoint: /start_agent

Method: POST

Content-Type: application/json

Request Body:

{
    "user_info": {
        "firstname": "John",
        "lastname": "Doe",
        "email": "[email protected]",
        "phone": "555-123-4567",
        "password": "SecurePass123!",
        "username": "johndoe123"
    },
    "starting_url": "https://example.com/register"
}

Curl Example:

curl -X POST \
  http://localhost:8000/start_agent \
  -H 'Content-Type: application/json' \
  -d '{
    "user_info": {
        "firstname": "John",
        "lastname": "Doe",
        "email": "[email protected]",
        "phone": "555-123-4567",
        "password": "SecurePass123!",
        "username": "johndoe123"
    },
    "starting_url": "https://example.com/register"
}'

2. Research Form Structure

Analyzes a form's structure using the form researcher agent.

Endpoint: /research_form

Method: POST

Content-Type: application/json

Request Body:

{
    "provider_id": "12345",
    "url": "https://example.com/form"
}

Curl Example:

curl -X POST \
  http://localhost:8000/research_form \
  -H 'Content-Type: application/json' \
  -d '{
    "provider_id": "12345",
    "url": "https://example.com/form"
}'

3. Submit User Response

Submits a user response to a pending agent question.

Endpoint: /omni-form/response

Method: POST

Content-Type: application/json

Request Body:

{
    "session_id": "550e8400-e29b-41d4-a716-446655440000",
    "request_id": "12345",
    "response_data": "user_response_here",
    "timestamp": "2024-03-20T10:00:00Z"
}

Curl Example:

curl -X POST \
  http://localhost:8000/omni-form/response \
  -H 'Content-Type: application/json' \
  -d '{
    "session_id": "550e8400-e29b-41d4-a716-446655440000",
    "request_id": "12345",
    "response_data": "user_response_here",
    "timestamp": "2024-03-20T10:00:00Z"
}'

Notes

• All endpoints expect JSON data in the request body
• The base URL can be configured in your environment
• Timestamps should be in ISO 8601 format
• Session IDs are UUIDs