{{template "views/partials/head" .}}
{{template "views/partials/navbar" .}}

Back

Task Information


                    

                

            


            
            

                
API Usage Examples

                

                    Use these curl commands to interact with this task programmatically.
                

                
                

                    
                    

                        

                            
                            Execute Task by ID
                        

                        

                            
curl -X POST {{ .BaseURL }}api/agent/jobs/execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "task_id": "",
    "parameters": {
      "user_name": "Alice",
      "job_title": "Software Engineer",
      "task_description": "Review code changes"
    }
  }'

                        

                    

                    
                    
                    

                        

                            
                            Execute Task by Name
                        

                        

                            
curl -X POST {{ .BaseURL }}api/agent/tasks//execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "user_name": "Bob",
    "job_title": "Data Scientist",
    "task_description": "Analyze sales data"
  }'

                        

                        

                            
                            The request body should be a JSON object where keys are parameter names and values are strings. 
                            If no body is provided, the task will execute with empty parameters.
                        

                    

                    
                    
                    

                        

                            
                            Execute Task with Multimedia (Images)
                        

                        

                            
curl -X POST {{ .BaseURL }}api/agent/jobs/execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "task_id": "",
    "parameters": {
      "user_name": "Alice",
      "task_description": "Analyze this image"
    },
    "images": [
      "https://example.com/image.png",
      "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
    ]
  }'

                        

                        

                            You can provide multimedia content as URLs or base64-encoded data URIs. Supported types: images, videos, audios, and files.
                        

                    

                    
                    
                    

                        

                            
                            Check Job Status
                        

                        

                            
curl -X GET {{ .BaseURL }}api/agent/jobs/JOB_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

                        

                        

                            After executing a task, you will receive a job_id in the response. Use it to query the job's status and results.
                        

                    

                

            


            
            

                
Webhook Configuration

                

                    
                

            

        


        
        
    


    
    

        

            

                
Execute Task