headlessagents 1.0.0

Python SDK for interacting with Headless Agents API

HeadlessAgents Python SDK 1.0.0

Welcome to the HeadlessAgents SDK documentation. This guide will help you get started with integrating and using the HeadlessAgents SDK in your project.

Versions

• API version: 1.0.0
• SDK version: 1.0.0

About the API

API for interacting with Headless Agents

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • API Key Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install headlessagents

Authentication

API Key Authentication

The HeadlessAgents API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

HeadlessAgents(
    api_key="YOUR_API_KEY",
    timeout=10000
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_api_key("YOUR_API_KEY")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from headlessagents import HeadlessAgents

sdk = HeadlessAgents(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from headlessagents import HeadlessAgents

sdk = HeadlessAgents(
    api_key="YOUR_API_KEY",
    timeout=10000
)

result = sdk.system.health_check()

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from headlessagents import HeadlessAgentsAsync

sdk = HeadlessAgentsAsync(
    api_key="YOUR_API_KEY",
    timeout=10000
)


async def main():
  result = await sdk.system.health_check()
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
system
agents
execution
analysis
schema
threads

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
HealthCheckOkResponse
AgentCreate
Agent
AgentUpdate
CallAgentRequest
CallAgentOkResponse
DigestRequest
CreateDigestOkResponse
SchemaCreateRequest
CreateSchemaOkResponse
Thread
ThreadMessage