mirror of
https://github.com/msoedov/agentic_security.git
synced 2026-06-24 06:09:55 +02:00
feat(add docs):
This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
# API Reference
|
||||
|
||||
This section provides detailed information about the Agentic Security API.
|
||||
|
||||
## Endpoints
|
||||
|
||||
### `/v1/self-probe`
|
||||
|
||||
- **Method**: POST
|
||||
- **Description**: Used for integration testing.
|
||||
- **Request Body**:
|
||||
```json
|
||||
{
|
||||
"prompt": "<<PROMPT>>"
|
||||
}
|
||||
```
|
||||
|
||||
### `/v1/self-probe-image`
|
||||
|
||||
- **Method**: POST
|
||||
- **Description**: Probes the image modality.
|
||||
- **Request Body**:
|
||||
```json
|
||||
[
|
||||
{
|
||||
"role": "user",
|
||||
"content": [
|
||||
{
|
||||
"type": "text",
|
||||
"text": "What is in this image?"
|
||||
},
|
||||
{
|
||||
"type": "image_url",
|
||||
"image_url": {
|
||||
"url": "data:image/jpeg;base64,<<BASE64_IMAGE>>"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
All API requests require an API key. Include it in the `Authorization` header:
|
||||
```
|
||||
Authorization: Bearer YOUR_API_KEY
|
||||
```
|
||||
|
||||
## Further Reading
|
||||
|
||||
For more details on API usage, refer to the [Configuration](configuration.md) section.
|
||||
Reference in New Issue
Block a user