How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opply Recommendations API

The Recommendations API from Opply — 11 operation(s) for recommendations.

Opply Recommendations API is one of 47 APIs that Opply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Recommendations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 11 paths, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.

Requests are made against the base URL https://api.opply.com.

11 operations 11 paths 12 schemas 3 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.0
Base URL
https://api.opply.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Opply Recommendations API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 3 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Recommendations 11
GET
/api/v1/recommendations/
List recommendations for the current buyer
api_v1_recommendations_list 2 params → 200
GET
/api/v1/recommendations/{uuid}/
Fetch a single recommendation by UUID (any lifecycle state)
api_v1_recommendations_retrieve 1 param → 200
POST
/api/v1/recommendations/{uuid}/act/
Buyer-scoped recommendations (the agent-curated nudge feed). Scoped to audience=buyer recommendations whose subject is the authenticated user's company. list defaults to state=active (the feed); pass…
api_v1_recommendations_act_create 1 param → 200
POST
/api/v1/recommendations/{uuid}/dismiss/
Buyer-scoped recommendations (the agent-curated nudge feed). Scoped to audience=buyer recommendations whose subject is the authenticated user's company. list defaults to state=active (the feed); pass…
api_v1_recommendations_dismiss_create 1 param → 200
POST
/api/v1/recommendations/{uuid}/mark-stale/
Buyer-scoped recommendations (the agent-curated nudge feed). Scoped to audience=buyer recommendations whose subject is the authenticated user's company. list defaults to state=active (the feed); pass…
api_v1_recommendations_mark_stale_create 1 param body → 200
POST
/api/v1/recommendations/{uuid}/restore/
Buyer-scoped recommendations (the agent-curated nudge feed). Scoped to audience=buyer recommendations whose subject is the authenticated user's company. list defaults to state=active (the feed); pass…
api_v1_recommendations_restore_create 1 param → 200
POST
/api/v1/recommendations/{uuid}/snooze/
Buyer-scoped recommendations (the agent-curated nudge feed). Scoped to audience=buyer recommendations whose subject is the authenticated user's company. list defaults to state=active (the feed); pass…
api_v1_recommendations_snooze_create 1 param body → 200
POST
/api/v1/recommendations/{uuid}/supersede/
Buyer-scoped recommendations (the agent-curated nudge feed). Scoped to audience=buyer recommendations whose subject is the authenticated user's company. list defaults to state=active (the feed); pass…
api_v1_recommendations_supersede_create 1 param body → 200
GET
/api/v1/recommendations/recent-actions/
Recent recipient actions (for the agent's cooldown check)
api_v1_recommendations_recent_actions_retrieve 1 param → 200
POST
/api/v1/recommendations/seed-recommendation/
POST /api/v1/recommendations/seed-recommendation/ — staff-only. Body {companyuuid?}. Creates a ready-made supplierconcentration recommendation directly — no agent run — for that buyer (defaulting to…
api_v1_recommendations_seed_recommendation_create body → 201
POST
/api/v1/recommendations/trigger-recommendations/
POST /api/v1/recommendations/trigger-recommendations/ — staff-only. Body {companyuuid?}. Creates the recommender-run Task for that buyer (defaulting to the caller's own company); the existing dispatc…
api_v1_recommendations_trigger_recommendations_create body → 201

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are RecommendationActResponse (16 properties), RecommendationRead (15 properties), PaginatedRecommendationReadList (3 properties), TriggerRecommenderRunResponse (2 properties). Each schema is shown below with its type and property counts.

SeedRecommendationResponse
object
1 property 1 required
TriggerRecommenderRunResponse
object
2 properties 2 required
_DebugCompanyTargetRequest
object
1 property
RecommendationStateEnum
string
active - Active superseded - Superseded dismissed - Dismissed snoozed - Snoozed acted - Acted stale - Stale
SupersedeRequest
object
1 property 1 required
RecommendationRead
object
Buyer-facing read view of a recommendation, with its cited insights. citedinsights is ordered primary-first so the FE can read citedinsights[0] as the headline…
15 properties 7 required
PaginatedRecommendationReadList
object
3 properties 1 required
MarkStaleRequest
object
1 property
RecommendationSeverityEnum
integer
1 - Low 2 - Medium 3 - High 4 - Critical
SnoozeRequest
object
1 property 1 required
RecommendationActResponse
object
The act response: the read view plus the uuid of the follow-up task the CTA created (null for kinds with no task action), so the FE can show a "task created" t…
16 properties 8 required
RecommendationAudienceEnum
string
buyer - Buyer mor - Merchant of Record supplier - Supplier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-recommendations-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
Opply Admin panel API
Opply Agents API
Opply Agreements API
Opply api API
Opply App Orders API
Opply Brain API
Opply Brands API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Where this information came from

This is an independent, third-party profile of Opply Recommendations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.