optimization-jobs

Create Job

Changed on

Create a new prompt optimization job.

post/api/v1/repos/{owner}/{repo}/optimization-jobs

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/repos/{owner}/{repo}/optimization-jobs
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

repostring required

Request body

algorithm'promptim' | 'demo' required

Response

Successful Response

idstring uuid required
repo_idstring uuid required
status'created' | 'running' | 'successful' | 'failed' required
tenant_idstring uuid required
algorithm'promptim' | 'demo' required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status