Pidj API

Name: Pidj API
Brand: Pidj API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsSms Messagingbasic21 EndpointsREST

For Agents

Send business SMS messages, manage contacts and user accounts, and orchestrate automated messaging tasks for customer communication.

Install Jentic One Beta

Connect the Pidj API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Pidj API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Pidj API.

Send SMS messages to contacts with delivery tracking

Initiate automated messaging tasks for bulk outreach campaigns

Manage contact records with phone number and profile data

Administer user accounts with pause, unpause, and recovery controls

GET STARTED

Start building with Pidj API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Pidj API for, with concrete tasks.

★ Business SMS Outreach

Send transactional and promotional SMS messages to customers through Pidj. The /send endpoint accepts recipient phone numbers and message content, delivering messages with status tracking. Businesses use this for appointment reminders, order confirmations, and marketing campaigns.

Send an SMS message to contact phone number +15551234567 with the text 'Your order has shipped' and confirm delivery status

Automated Messaging Tasks

Orchestrate multi-step messaging campaigns by initiating tasks through the Pidj API. The /task/initiate endpoint triggers automated workflows that send sequences of messages to contact groups, enabling drip campaigns, follow-up sequences, and scheduled outreach without manual intervention.

Initiate a messaging task targeting contact group with automated follow-up sequence

Contact and User Management

Maintain a central contact database and manage user accounts through the Pidj API. Create contacts with phone numbers and metadata, administer user access with pause and recovery controls, and configure SSO for team authentication.

Create a new contact with phone number +15559876543 and name 'Jane Doe', then list all active contacts

AI Agent SMS Integration

AI agents use the Pidj API through Jentic to send SMS messages and manage contacts without manual API configuration. Agents search for messaging operations by intent, load the endpoint schema, and execute calls with Jentic handling Basic authentication and message formatting.

Search Jentic for 'send business SMS message', load the Pidj /send endpoint schema, and send a message to a customer contact

Key Endpoints

21 endpoints — jentic publishes the only available openapi specification for pidj api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/send

Send an SMS message

POST

/task/initiate

Initiate an automated messaging task

GET

/user/{id}

Retrieve user account details

POST

/user

Create a new user account

POST

/user/{id}/pause

Pause a user account

POST

/user/{id}/unpause

Unpause a user account

GET

/contact/{id}

Retrieve a contact record

GET

/sso/url

Generate SSO authentication URL

POST

/send

Send an SMS message

POST

/task/initiate

Initiate an automated messaging task

GET

/user/{id}

Retrieve user account details

POST

/user

Create a new user account

POST

/user/{id}/pause

Pause a user account

POST

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Pidj Basic auth credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens so raw passwords never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'send a business SMS') and Jentic returns matching Pidj operations with their input schemas, so the agent can call the right endpoint without reading docs.

Time to first call

Direct Pidj integration: 1-2 days for auth setup and message formatting. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Pidj API through Jentic.

Why is there no official OpenAPI spec for Pidj API?

Pidj does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Pidj API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Pidj API use?

The Pidj API uses HTTP Basic authentication with your account credentials. Through Jentic, these credentials are stored encrypted in the MAXsystem vault and agents receive scoped access without handling raw passwords directly.

Can I send bulk SMS messages with the Pidj API?

Yes. The /task/initiate endpoint triggers automated messaging workflows that send messages to groups of contacts. For individual messages, use the /send endpoint with a single recipient phone number.

How do I pause and resume a user account through the Pidj API?

Use POST /user/{id}/pause to temporarily suspend a user account and POST /user/{id}/unpause to reactivate it. The /user/{id}/recover endpoint handles account recovery scenarios.

How do I send an SMS through the Pidj API using Jentic?

Search Jentic for 'send business SMS message', load the /send operation schema, and execute with recipient phone number and message body. Jentic injects Basic auth headers automatically and returns delivery status.

Does the Pidj API support contact segmentation?

The API provides contact management through the /contact endpoints where you can create, retrieve, and update contact records. Contact grouping for targeted messaging is handled through the task initiation workflow.

Pidj API

Connect the Pidj API to your agent

Capabilities

Start building with Pidj API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs