# Models

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The Agent object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"Agent":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"bio":{"type":"array","items":{"type":"string"}},"knowledge":{"type":"array","items":{"type":"string"}},"channels":{"type":"array","items":{"type":"string"}},"model_provider":{"type":"string"},"status":{"type":"string","enum":["created","active","running","paused","stopped","removed","failed"]},"settings":{"type":"object","properties":{"model":{"type":"string"},"thinking":{"type":"string","enum":["off","low","medium","high"],"default":"medium"},"extra_instructions":{"type":"string","nullable":true},"trusted_proxies":{"type":"array","items":{"type":"string"}},"secrets":{"type":"object","description":"Channel secrets (key-value map)","additionalProperties":{"type":"string"}},"POST_IMMEDIATELY":{"type":"boolean"},"POST_INTERVAL_MIN":{"type":"integer"},"POST_INTERVAL_MAX":{"type":"integer"},"TWITTER_POLL_INTERVAL":{"type":"integer"},"ACTION_TIMELINE_TYPE":{"type":"string","enum":["following","foryou"]},"MAX_ACTIONS_PROCESSING":{"type":"integer"},"ACTION_INTERVAL":{"type":"integer"}}},"secrets_configured":{"type":"object","description":"Map of secret names to boolean (set or not). Values are never exposed.","additionalProperties":{"type":"boolean"}},"face_image_path":{"type":"string","nullable":true},"face_image_generation_prompt":{"type":"string","nullable":true},"auto_generation_prompt":{"type":"string","nullable":true},"auto_enhancement_prompt":{"type":"string","nullable":true},"is_featured":{"type":"boolean"},"last_boot_execution":{"type":"string","format":"date-time","nullable":true},"last_stop_execution":{"type":"string","format":"date-time","nullable":true},"uptime_total_seconds":{"type":"integer"},"user_id":{"type":"string","format":"uuid"},"framework_id":{"type":"string","format":"uuid"},"framework":{"$ref":"#/components/schemas/CatalogFramework"},"hardware_config":{"type":"object","nullable":true,"properties":{"region":{"$ref":"#/components/schemas/CatalogRegion"},"ram":{"$ref":"#/components/schemas/CatalogHardwareOption"},"disk":{"$ref":"#/components/schemas/CatalogHardwareOption"},"gpu":{"$ref":"#/components/schemas/CatalogHardwareOption"},"cpu":{"$ref":"#/components/schemas/CatalogHardwareOption"}}},"client_links":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"link":{"type":"string"}}}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"CatalogFramework":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string","nullable":true},"available":{"type":"boolean"},"tag":{"type":"string","nullable":true}}},"CatalogRegion":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"label":{"type":"string"},"city":{"type":"string"},"coords":{"type":"object","properties":{"lat":{"type":"number","format":"float"},"lng":{"type":"number","format":"float"}}},"available":{"type":"boolean"}}},"CatalogHardwareOption":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string","nullable":true},"available":{"type":"boolean"}}}}}}
```

## The AgentSettingsInput object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"AgentSettingsInput":{"type":"object","description":"Input schema for creating or updating an agent","properties":{"name":{"type":"string","maxLength":255},"llm_provider_name":{"type":"string"},"llm_provider_model":{"type":"string"},"bio":{"type":"array","maxItems":50,"items":{"type":"string","maxLength":2000}},"knowledge":{"type":"array","maxItems":100,"items":{"type":"string","maxLength":5000}},"channels":{"type":"array","maxItems":10,"items":{"type":"string"}},"model_provider":{"type":"string"},"settings":{"type":"object","properties":{"model":{"type":"string","maxLength":255},"thinking":{"type":"string","enum":["off","low","medium","high"]},"extra_instructions":{"type":"string","maxLength":10000},"secrets":{"type":"object","description":"Key-value map. Send null or \"\" to delete a secret; omit the key to keep it.","additionalProperties":{"type":"string","nullable":true}},"trusted_proxies":{"type":"array","maxItems":10,"items":{"type":"string"}},"POST_IMMEDIATELY":{"type":"boolean"},"POST_INTERVAL_MIN":{"type":"integer","minimum":1,"maximum":10080},"POST_INTERVAL_MAX":{"type":"integer","minimum":1,"maximum":10080},"TWITTER_POLL_INTERVAL":{"type":"integer","minimum":10,"maximum":86400},"ACTION_TIMELINE_TYPE":{"type":"string","enum":["following","foryou"]},"MAX_ACTIONS_PROCESSING":{"type":"integer","minimum":1,"maximum":100},"ACTION_INTERVAL":{"type":"integer","minimum":1,"maximum":10080}}},"auto_generation_prompt":{"type":"string","maxLength":10000},"auto_enhancement_prompt":{"type":"string","maxLength":10000},"framework_id":{"type":"string","format":"uuid"},"region_id":{"type":"string","format":"uuid"},"ram_id":{"type":"string","format":"uuid"},"disk_id":{"type":"string","format":"uuid"},"gpu_id":{"type":"string","format":"uuid"},"cpu_id":{"type":"string","format":"uuid"}}}}}}
```

## The CatalogFramework object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"CatalogFramework":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string","nullable":true},"available":{"type":"boolean"},"tag":{"type":"string","nullable":true}}}}}}
```

## The CatalogRegion object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"CatalogRegion":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"label":{"type":"string"},"city":{"type":"string"},"coords":{"type":"object","properties":{"lat":{"type":"number","format":"float"},"lng":{"type":"number","format":"float"}}},"available":{"type":"boolean"}}}}}}
```

## The CatalogHardwareOption object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"CatalogHardwareOption":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string","nullable":true},"available":{"type":"boolean"}}}}}}
```

## The CatalogChannel object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"CatalogChannel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string","nullable":true},"available":{"type":"boolean"},"always_on":{"type":"boolean"}}}}}}
```

## The CatalogModel object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"CatalogModel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"model_id":{"type":"string"},"provider":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"is_free":{"type":"boolean"},"is_default":{"type":"boolean"}}}}}}
```

## The Session object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"Session":{"type":"object","properties":{"key":{"type":"string"},"sessionId":{"type":"string","format":"uuid"},"sessionFile":{"type":"string"},"label":{"type":"string","nullable":true},"updatedAt":{"type":"integer","description":"Unix timestamp in milliseconds"},"chatType":{"type":"string"},"lastChannel":{"type":"string"},"origin":{"type":"object"}}}}}}
```

## The ChatMessage object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"ChatMessage":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["user","assistant"]},"content":{"description":"String or array of content blocks","oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}}]},"timestamp":{"type":"integer"}}}}}}
```

## The Archive object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"Archive":{"type":"object","properties":{"filename":{"type":"string"},"label":{"type":"string","nullable":true},"archivedAt":{"type":"string"},"sessionId":{"type":"string"}}}}}}
```

## The Subscription object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"Subscription":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"user_id":{"type":"string","format":"uuid"},"tier_slug":{"type":"string"},"status":{"type":"string","enum":["active","trialing","past_due","canceled","incomplete","incomplete_expired","unpaid","paused"]},"stripe_subscription_id":{"type":"string","nullable":true},"stripe_customer_id":{"type":"string","nullable":true},"started_at":{"type":"string","format":"date-time","nullable":true},"monthly_credits":{"type":"integer"},"current_period_start":{"type":"string","format":"date-time","nullable":true},"current_period_end":{"type":"string","format":"date-time","nullable":true},"trial_start":{"type":"string","format":"date-time","nullable":true},"trial_end":{"type":"string","format":"date-time","nullable":true},"cancel_at_period_end":{"type":"boolean","nullable":true},"cancel_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tier":{"$ref":"#/components/schemas/Tier"}}},"Tier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"name":{"type":"string"},"monthly_credits":{"type":"integer"},"price":{"type":"number","format":"float"},"features":{"type":"array","nullable":true,"items":{"type":"string"}},"max_running_agents":{"type":"integer","nullable":true},"allowed_channels":{"type":"array","nullable":true,"items":{"type":"string"}},"can_buy_credit_packages":{"type":"boolean"},"trial_days":{"type":"integer"},"is_active":{"type":"boolean"},"sort_order":{"type":"integer"}}}}}}
```

## The Tier object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"Tier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"name":{"type":"string"},"monthly_credits":{"type":"integer"},"price":{"type":"number","format":"float"},"features":{"type":"array","nullable":true,"items":{"type":"string"}},"max_running_agents":{"type":"integer","nullable":true},"allowed_channels":{"type":"array","nullable":true,"items":{"type":"string"}},"can_buy_credit_packages":{"type":"boolean"},"trial_days":{"type":"integer"},"is_active":{"type":"boolean"},"sort_order":{"type":"integer"}}}}}}
```

## The CreditBreakdown object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"CreditBreakdown":{"type":"object","properties":{"total_credits":{"type":"integer"},"subscription_credits":{"type":"integer"},"purchased_credits":{"type":"integer"}}}}}}
```

## The ValidationError object

```json
{"openapi":"3.0.3","info":{"title":"Guayaba Public API v1","version":"1.0"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.guayaba.run/documentation/api-reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.