MechaMental
Api reference

Prompt Protection Policies

List Policies

GET
/v1/orgs/{org_id}/prompt-protection-policies

Path Parameters

org_id*Org Id

Query Parameters

enabled_only?Enabled Only
Defaultfalse
limit?Limit
Default50
Range1 <= value <= 100
cursor?string|null

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "policies": [
    {
      "policy_id": "string",
      "organization_id": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "priority": 0,
      "system_prompt": "string",
      "apply_to_all_workspaces": true,
      "workspace_ids": [
        "string"
      ],
      "app_ids": [],
      "augmentation_ids": [],
      "output_formats": [],
      "output_validation_rules": [],
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string",
      "current_version_number": 0,
      "total_versions": 0
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Policy

POST
/v1/orgs/{org_id}/prompt-protection-policies

Path Parameters

org_id*Org Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/prompt-protection-policies" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "system_prompt": "string"  }'
{
  "policy_id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "priority": 0,
  "system_prompt": "string",
  "apply_to_all_workspaces": true,
  "workspace_ids": [
    "string"
  ],
  "app_ids": [],
  "augmentation_ids": [],
  "output_formats": [],
  "output_validation_rules": [],
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "current_version_number": 0,
  "total_versions": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Templates

GET
/v1/orgs/{org_id}/prompt-protection-policies/templates

Path Parameters

org_id*Org Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies/templates"
[
  {
    "template_id": "string",
    "name": "string",
    "description": "string",
    "category": "string",
    "system_prompt": "string",
    "suggested_priority": 0,
    "suggested_output_validation_rules": []
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Preview For Workspace

GET
/v1/orgs/{org_id}/prompt-protection-policies/preview/{workspace_id}

Path Parameters

org_id*Org Id
workspace_id*Workspace Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies/preview/string"
{
  "workspace_id": "string",
  "policies_applied": [
    {
      "policy_id": "string",
      "organization_id": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "priority": 0,
      "system_prompt": "string",
      "apply_to_all_workspaces": true,
      "workspace_ids": [
        "string"
      ],
      "app_ids": [],
      "augmentation_ids": [],
      "output_formats": [],
      "output_validation_rules": [],
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string",
      "current_version_number": 0,
      "total_versions": 0
    }
  ],
  "combined_system_prompt": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Policy

GET
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}

Path Parameters

org_id*Org Id
policy_id*Policy Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies/string"
{
  "policy_id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "priority": 0,
  "system_prompt": "string",
  "apply_to_all_workspaces": true,
  "workspace_ids": [
    "string"
  ],
  "app_ids": [],
  "augmentation_ids": [],
  "output_formats": [],
  "output_validation_rules": [],
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "current_version_number": 0,
  "total_versions": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Policy

PATCH
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}

Path Parameters

org_id*Org Id
policy_id*Policy Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "https://loading/v1/orgs/string/prompt-protection-policies/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "policy_id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "priority": 0,
  "system_prompt": "string",
  "apply_to_all_workspaces": true,
  "workspace_ids": [
    "string"
  ],
  "app_ids": [],
  "augmentation_ids": [],
  "output_formats": [],
  "output_validation_rules": [],
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "current_version_number": 0,
  "total_versions": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Delete Policy

DELETE
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}

Path Parameters

org_id*Org Id
policy_id*Policy Id

Header Parameters

authorization?string|null

Response Body

application/json

curl -X DELETE "https://loading/v1/orgs/string/prompt-protection-policies/string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Versions

GET
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}/versions

Path Parameters

org_id*Org Id
policy_id*Policy Id

Query Parameters

limit?Limit
Default50
Range1 <= value <= 100
cursor?string|null

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies/string/versions"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "versions": [
    {
      "version_id": "string",
      "policy_id": "string",
      "version_number": 0,
      "is_current": true,
      "content_length": 0,
      "content_hash": "string",
      "created_by": "string",
      "created_at": "string",
      "change_summary": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Version

GET
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}/versions/{version_number}

Path Parameters

org_id*Org Id
policy_id*Policy Id
version_number*Version Number

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies/string/versions/0"
{
  "version_id": "string",
  "policy_id": "string",
  "version_number": 0,
  "is_current": true,
  "content_length": 0,
  "content_hash": "string",
  "created_by": "string",
  "created_at": "string",
  "change_summary": "string",
  "system_prompt": "string",
  "output_validation_rules": []
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Diff Versions

GET
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}/versions/{from_version}/diff/{to_version}

Path Parameters

org_id*Org Id
policy_id*Policy Id
from_version*From Version
to_version*To Version

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/prompt-protection-policies/string/versions/0/diff/0"
{
  "policy_id": "string",
  "from_version": 0,
  "to_version": 0,
  "system_prompt_changed": true,
  "system_prompt_diff": "string",
  "rules_changed": true,
  "rules_added": [],
  "rules_removed": [],
  "rules_modified": []
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Restore Version

POST
/v1/orgs/{org_id}/prompt-protection-policies/{policy_id}/versions/{version_number}/restore

Path Parameters

org_id*Org Id
policy_id*Policy Id
version_number*Version Number

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/prompt-protection-policies/string/versions/0/restore"
{
  "policy_id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "priority": 0,
  "system_prompt": "string",
  "apply_to_all_workspaces": true,
  "workspace_ids": [
    "string"
  ],
  "app_ids": [],
  "augmentation_ids": [],
  "output_formats": [],
  "output_validation_rules": [],
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "current_version_number": 0,
  "total_versions": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Platform Invites

Previous Page

Provider Accounts

Next Page