AI

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• user

• user_count

• userExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• user_id

• type

• status

• reported

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• created_at

• updated_at

• status

• type

• reported

Authorizations

ApiKeyAuth

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/ai/conversations

HTTPcURLJavaScriptPython

GET /api/v1/ai/conversations HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/ai/conversations",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/ai/conversations?page=1",
    "last": "https://api.example.com/api/v1/ai/conversations?page=1",
    "prev": null,
    "next": null
  }
}

Generate

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
userPrompt	string	☑
examplePayload	string
language

Authorizations

ApiKeyAuth

Body

application/json

userPromptstringRequired

examplePayloadstringOptional

languagestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/ai/scripts/generate

HTTPcURLJavaScriptPython

POST /api/v1/ai/scripts/generate HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "userPrompt": "example_userPrompt",
  "examplePayload": "example_examplePayload",
  "language": "example_language"
}

{}

Reply

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
userReply	string	☑

Authorizations

ApiKeyAuth

Path parameters

conversationUlidstringRequired

The conversationUlid identifier.

Body

application/json

userReplystringRequired

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/ai/scripts/{conversationUlid}/reply

HTTPcURLJavaScriptPython

POST /api/v1/ai/scripts/{conversationUlid}/reply HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "userReply": "example_userReply"
}

{}

End

patch

End for end.

Authorizations

ApiKeyAuth

Path parameters

conversationUlidstringRequired

The conversationUlid identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/ai/{conversationUlid}/end

HTTPcURLJavaScriptPython

PATCH /api/v1/ai/{conversationUlid}/end HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Report

patch

Report for report.

Authorizations

ApiKeyAuth

Path parameters

conversationUlidstringRequired

The conversationUlid identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/ai/{conversationUlid}/report

HTTPcURLJavaScriptPython

PATCH /api/v1/ai/{conversationUlid}/report HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}