SkyClaw

https://skyworkai.github.io/skyclaw/
Admin
SkyClaw is a high-performance agent model for complex tool use, multi-turn workflows, and real-world...
Tokens:1,631
Snippets:15
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Chat Completions (Python OpenAI SDK)

Source: https://skyworkai.github.io/skyclaw

Example of how to use the OpenAI Python SDK to interact with the SkyClaw API. This simplifies the process of making API calls.

```APIDOC
## Chat Completions with OpenAI SDK

### Description
Utilizes the OpenAI Python SDK to send requests to the SkyClaw API endpoint for chat completions.

### Method
Uses the `client.chat.completions.create` method from the OpenAI SDK.

### Endpoint Configuration
- **base_url**: `https://api.apifree.ai/v1`
- **api_key**: `your-api-key`

### Parameters
- **model** (string) - Required - The model to use, e.g., `skywork-ai/skyclaw-v1` or `skywork-ai/skyclaw-v1-lite`.
- **messages** (list of dict) - Required - A list of message dictionaries, where each dictionary has a `role` (string, e.g., "user" or "assistant") and `content` (string).

### Request Example
```python
from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="https://api.apifree.ai/v1"
)

response = client.chat.completions.create(
    model="skywork-ai/skyclaw-v1",
    messages=[
        {"role": "user", "content": "Hello, SkyClaw!"}
    ]
)
print(response.choices[0].message.content)
```

### Response
#### Success Response
- **choices** (list) - A list containing the model's response(s).
  - **message** (dict)
    - **content** (string) - The generated text content from the model.
```

--------------------------------

### Chat Completions (cURL)

Source: https://skyworkai.github.io/skyclaw

Example of how to call the SkyClaw API using cURL for chat completions. This demonstrates the necessary headers and JSON payload.

```APIDOC
## POST /v1/chat/completions

### Description
Sends a prompt to the SkyClaw model to generate a chat completion.

### Method
POST

### Endpoint
https://api.apifree.ai/v1/chat/completions

### Parameters
#### Headers
- **Content-Type** (string) - Required - `application/json`
- **Authorization** (string) - Required - `Bearer $APIFREE_API_KEY`

#### Request Body
- **model** (string) - Required - The model to use, e.g., `skywork-ai/skyclaw-v1` or `skywork-ai/skyclaw-v1-lite`.
- **messages** (array) - Required - An array of message objects, where each object has a `role` (string, e.g., "user" or "assistant") and `content` (string).

### Request Example
```json
{
  "model": "skywork-ai/skyclaw-v1",
  "messages": [
    {"role": "user", "content": "Hello, SkyClaw!"}
  ]
}
```

### Response
#### Success Response (200)
- **choices** (array) - An array containing the model's response(s).
  - **message** (object)
    - **content** (string) - The generated text content from the model.
```

--------------------------------

### Call SkyClaw API with Python (OpenAI SDK)

Source: https://skyworkai.github.io/skyclaw

This Python script demonstrates how to use the OpenAI SDK to interact with the SkyClaw API. Configure the 'base_url' and 'api_key' accordingly.

```python
from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="https://api.apifree.ai/v1"
)

response = client.chat.completions.create(
    model="skywork-ai/skyclaw-v1",
    messages=[
        {"role": "user", "content": "Hello, SkyClaw!"}
    ]
)
print(response.choices[0].message.content)
```

--------------------------------

### Call SkyClaw API with cURL

Source: https://skyworkai.github.io/skyclaw

Use this cURL command to send a chat completion request to the SkyClaw API. Ensure you replace '$APIFREE_API_KEY' with your actual API key.

```shell
curl https://api.apifree.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIFREE_API_KEY" \
  -d '{
    "model": "skywork-ai/skyclaw-v1",
    "messages": [
      {"role": "user", "content": "Hello, SkyClaw!"}
    ]
  }'
```
Tokens:
Raw