Skip to main content
GET
https://agent.usedari.com
/
portals
/
{org_id}
/
{endpoint_name}
curl https://agent.usedari.com/portals/my-org/contact_form \
  -H "X-API-Key: YOUR_API_KEY"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "my-org",
  "endpoint_name": "contact_form",
  "start_url": "https://example.com/contact",
  "task": "Fill out the contact form",
  "form_schema": {
    "type": "object",
    "properties": {
      "name": {"type": "string"},
      "email": {"type": "string"}
    },
    "required": ["name", "email"]
  },
  "output_schema": null,
  "profile_id": null,
  "humanized_urls": null,
  "skills": [],
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}
Returns a single portal by its organization ID and endpoint name.

Path Parameters

org_id
string
required
Organization ID
endpoint_name
string
required
Portal endpoint name

Headers

X-API-Key
string
required
Organization API key

Response Fields

id
string
UUID of the portal
org_id
string
Organization ID
endpoint_name
string
Endpoint name
start_url
string
Starting URL
task
string
Task description
form_schema
object
Input JSON Schema
output_schema
object
Output JSON Schema
profile_id
string
Browser profile UUID
humanized_urls
string[]
Humanized URLs
skills
object[]
Attached skills
created_at
string
ISO 8601 timestamp
updated_at
string
ISO 8601 timestamp
curl https://agent.usedari.com/portals/my-org/contact_form \
  -H "X-API-Key: YOUR_API_KEY"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "my-org",
  "endpoint_name": "contact_form",
  "start_url": "https://example.com/contact",
  "task": "Fill out the contact form",
  "form_schema": {
    "type": "object",
    "properties": {
      "name": {"type": "string"},
      "email": {"type": "string"}
    },
    "required": ["name", "email"]
  },
  "output_schema": null,
  "profile_id": null,
  "humanized_urls": null,
  "skills": [],
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Error Responses

{
  "detail": "Portal not found"
}